Readme File / Local Build Instructions #23
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
help wanted
Extra attention is needed
Currently, as far as I can tell, there is no README or document that outlines how contribute to the docs / build the project locally.
Whilst its fairly simple to get started if you have used Sphinx before, it adds additional complexity for newcomers to the project/Sphinx to contribute.
Adding a light README file with the following to the repo should help lower the barrier for contribution.
pip install -r requirements.txt && make html && python -m http.server -d _build
The text was updated successfully, but these errors were encountered: