Skip to content

Files

Latest commit

65544e2 · Oct 26, 2024

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jul 10, 2022
Mar 16, 2017
Mar 23, 2018
Jan 9, 2014
Jan 1, 2024
Jul 25, 2015
Jul 5, 2024
Feb 28, 2016
Jun 20, 2022
Jan 9, 2014
Oct 26, 2024
Jan 25, 2021
Jun 24, 2022
Jan 9, 2014
Jun 20, 2022
Jan 9, 2014
Jul 21, 2022

Website and documentation

Errbot's website and documentation are built using Sphinx. Useful references when contributing to the docs are the reStructuredText Primer and Inline markup documents.

Requirements

Documentation must be built using Python 3. Additionally, extra requirements must be installed, which may be done through pip install -r docs/requirements.txt (note: you must run this from the root of the repository).

You must also have make installed in order to use the supplied Makefile.

Building and viewing locally

With the necessary requirements installed, the documentation can be built using the command make html. Once generated, the resulting pages can be viewed by opening _build/html/index.html in your webbrowser of choice.

Publishing to Read the Docs

Note: This is only relevant to project maintainers

Read the Docs should rebuild the site automatically when new commits are pushed. When new project releases are made, it may be necessary to add the new version and remove older versions (to prevent clutter in the version drop-down). This can be done at https://readthedocs.org/projects/errbot/versions/.