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

Add to README Documentation Building #176

Open
ramanxg opened this issue Mar 11, 2022 · 0 comments
Open

Add to README Documentation Building #176

ramanxg opened this issue Mar 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first task Good for newcomers Story Point 1 Quick copy change

Comments

@ramanxg
Copy link
Member

ramanxg commented Mar 11, 2022

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 ramanxg added documentation Improvements or additions to documentation good first task Good for newcomers Story Point 1 Quick copy change fellowship labels Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first task Good for newcomers Story Point 1 Quick copy change
Projects
Status: Fellowship Tasks
Development

No branches or pull requests

2 participants