Menu
▾
▴
[6870db]: / docs / README.md Maximize Restore History
36 lines (28 with data), 1.4 kB
OctoBot Docs
This is the OctoBot documentation which is deployed on docs.octobot.online.
It uses Sphinx to generate the website which is automatically re-deployed
upon each merge on dev branch.
Build this doc
To locally build this doc, first install Sphinx and the necessary requirements.
$ python3 -m pip -r doc_requirements.txt -r requirements.txt
Then go to the docs directory and run (depending on your os).
$ make html
$ make.bat html
The documentation website is now available at docs/build/html/index.html.
Contribute
To contribute to this documentation, please open a pull request to merge your contribution branch on dev.
Images
Images are stored on the assets branch of this repository. To add an image to this documentation, add it to the
assets branch (via pull request) and reference it directly from this doc.
Example with assets/wiki_resources/octobot_arch.svg stored at OctoBot/assets/wiki_resources/octobot_arch.svg:
.. image:: https://raw.githubusercontent.com/Drakkar-Software/OctoBot/assets/wiki_resources/octobot_arch.svg
:target: https://raw.githubusercontent.com/Drakkar-Software/OctoBot/assets/wiki_resources/octobot_arch.svg
:alt: OctoBot architecture