Manages andino ecosystem documentation.
Visit the website to see all th information.
_static
path.Settings
to be able to build the documentation automatically every time a push is done or a pull request is merged. This is configured automatically if you are admin on the repo group. If not, refer to this link.A bash script named get_readme.sh
is included in the repo to retrieve the latest version of the README.md
of andino packages to include them in the documentation. You just need to execute the script, it will clone the repo, extract the files and remove the repo:
chmod +x get_readme.sh
./get_readme.sh
NOTE: Use a virtual environment if you don't want to keep these requirements in your machine.
pip
sudo apt install python3-pip
dependencies
pip install -r docs/requirements.txt
sudo gedit ~/.bash_profile
export PATH="/home/$USER/.local/bin:$PATH"
In the docs folder
make html
Your index.rst
has been built into index.html
in your documentation output directory (_build/html/index.html
).
Open this file in your web browser to see your docs.
If you prefer, you can navigate to docs/_build/html
and do python3 -m http.server <port>
and you will be able to open the browser and see the docs at localhost:<port>
.