peterportal-public-api icon indicating copy to clipboard operation
peterportal-public-api copied to clipboard

Add to README Documentation Building

Open ramanxg opened this issue 2 years ago • 0 comments

Following the README instructions, the site won't actually load, because the documentation isn't built yet. The commands to build are

Note in instructions, that this isn't necessary, unless viewing the documentation.

  • pip install -r docs_requirements.txt
  • mkdocs build -d docs-site

Include link to https://api.peterportal.org/Contributing/documenting/, as it is right now, but the wording needs to be changed.

ramanxg avatar Mar 11 '22 01:03 ramanxg