Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

apidocs

Builds the API docs site from generated api *.md files.

To Build

To build:

  1. Prereq: python3, Node.js.

  2. 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
  3. Install the dependencies:

    npm ci
    npm run docs:install
  4. Generate the docs source files and build the site:

    npm run docs:build
  5. If you want to preview the docs site, you can use:

    npm run docs:preview
  6. 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.

Third Party Licenses

The requirements.txt lists the 3rd party libraries used for the docs. For the licenses, see the shared inrupt/docs-assets.