Builds the API docs site from generated api *.md files.
To build:
-
Optional but recommended. Create a virtual env:
python3 -m venv <path to the new virtual environment> source <path to the new virtual environment>/bin/activate
-
Install the dependencies:
npm ci npm run docs:install
-
Generate the docs source files and build the site:
npm run docs:build
-
If you want to preview the docs site, you can use:
npm run docs:preview
-
If you'd like to clean the generated docs and start fresh, you can use:
npm run docs:clean
When finished, can deactivate your virtual env.
The requirements.txt lists the 3rd party libraries used for the docs.
For the licenses, see the shared
inrupt/docs-assets.