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 documentation on how to build and run documentation locally #1893

Closed
MrPowers opened this issue Nov 21, 2023 · 2 comments · Fixed by #1913
Closed

Add documentation on how to build and run documentation locally #1893

MrPowers opened this issue Nov 21, 2023 · 2 comments · Fixed by #1913
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@MrPowers
Copy link
Collaborator

Description

The documentation can be run locally when the right packages are installed and commands are run.

Here's my understanding of the steps:

cd python
make develop
cd ..
mkdocs serve

We should document these steps, perhaps in the CONTRIBUTING.md file?

@MrPowers MrPowers added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 21, 2023
@r3stl355
Copy link
Contributor

r3stl355 commented Nov 25, 2023

you also need to install the docs requirements first time you run it, here is the full script

(cd python; make develop)
pip install -r docs/requirements.txt
mkdocs serve

I'll add this and few other bits to CONTRIBUTING.MD

@r3stl355
Copy link
Contributor

take

ion-elgreco pushed a commit that referenced this issue Nov 29, 2023
# Description
Added what I learned when I started contributing here, could save some
time to newcomers
Also added a `make` action to build new docs. Old (Sphinx) scripts are
still there, we should be good to remove those as we are not longer
building those docs, will do that separately

# Related Issue(s)
resolves #1893

Signed-off-by: Nikolay Ulmasov <[email protected]>
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants