Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

328 setup jsdoc in backend #337

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

// This one depends on where your file is located
import Highlight from "../../src/highlight.js"
import Highlight from "./highlight.js"
```

Each file should only contain documentation for a specific endpoint, and it should contain, at least, the following sections:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions documentation/code/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
docs/nijobs-be

24 changes: 24 additions & 0 deletions documentation/code/jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"source": {
"include": [ "src","package.json", "README.md"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": ["plugins/markdown"],
"opts": {
"readme": "./README.md",
"destination": "documentation/code/docs/",
"recurse": true,
"verbose": true,
"default_theme": "light",
"template": "./node_modules/clean-jsdoc-theme",
"theme_opts": {
"default_theme": "light"
},
"homepageTitle": "NIJobs Documentation"
},
"markdown": {
"hardwrap": false,
"idInHeadings": true
}
}
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Directory to change to before starting a build.
# This is where we will look for package.json/.nvmrc/etc.
# If not set, defaults to the root directory.
base = "documentation/"
base = "documentation/api"

# Directory that contains the deploy-ready HTML files and assets generated by
# the build. This is relative to the base directory if one has been set, or the
Expand Down
Loading
Loading