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

Pull request for sphinx-docu #316 #317

Open
44xtc44 opened this issue Jun 18, 2023 · 0 comments
Open

Pull request for sphinx-docu #316 #317

44xtc44 opened this issue Jun 18, 2023 · 0 comments

Comments

@44xtc44
Copy link

44xtc44 commented Jun 18, 2023

Announce for PR #316.
This is the documentation in rst format.
Please review, comment which parts to remove or update.
Or reject PR, pull from fork and cleanup yourself, PR.
The docu can be removed by del /docs folder.

RST documentation needs a little bit effort to test. You need to install some packages. The user don't need.
Pull the "sphinx-docu" branch to the local repo.
Go to /docs/source/config.py and read the doc_string,
or follow:

pip install -U sphinx
pip install sphinx-rtd-theme
pip install sphinxcontrib-napoleon

Use sphinx-apidoc to build your API documentation:

cd docs
sphinx-apidoc -f -o source/ ../scour/ # for PR done already!
make html

if you add a rst document, add to index.rst and rerun sphinx-apidoc -f -o source/ ../scour/

create a page, web hook, on readthedocs.org and update manually on docu change

Install sphinx packages, then open a terminal in /docs to execute Makefile: $ make html
open /docs/build/html/index.html
The output is the same as it is shown in readthedocs.org, if you login and create a web hook for the scour repo.
The /docs/buid folder is not needed for the functionality. Just for review.

Best regards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant