The goal of this repository is to set up a documentation as fast and as clean as possible. In your
source project you only need to install automl_sphinx_theme
to get all the features you need.
Those include automatic API generation, beautiful theme, numpy docstring interpretation, and
executing/plotting examples.
NO COMPLICATED .conf
OR SPHINX KNOWLEDGE ARE NECESSARY!
💖 You're welcome. 💖
- Include
name
,version
,author
,copyright
in{PACKAGE_NAME}/__init__.py
. - Copy the
docs
andexamples
directories to your root folder. You don't have to include all files but you should at least includedocs/conf.py
anddocs/Makefile
. - In
docs/conf.py
changesrc
to{PACKAGE_NAME}
. Adapt the file if needed. - Install this repo via pypi:
pip install automl_sphinx_theme
- You can generate the docs via
make html
inside the docs directory. Have a look inside theMakefile
to get more information and commands.
We recommend using the repository automl_template
which incorporates automl_sphinx_theme
automatically.
The documentation can be pushed automatically to a branch, which is used to display a webpage. Follow the steps to enable it:
- Copy
.github/workflows/docs.yml
to you root folder. - Create a new branch called
gh-pages
. - Go to
settings > pages
and selectgh-pages
as source.
AutoML Sphinx Theme provides the user to link older versions of documentations (must be done manually!). Specify versions
in the options to enable it. We recommend setting up a Github workflow which automatically pushes the latest tag to the gh-pages. From there, you could link the version directly.
- Logo: Add docs/images/logo.png.
- Favicon: Add docs/images/favicon.ico.