AutoML Theme for Sphinx
Project description
AutoML Sphinx Theme
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!
:sparkling_heart: You're welcome. :sparkling_heart:
Installation
- 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.
Github
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.
Customization
- Logo: Add docs/images/logo.png.
- Favicon: Add docs/images/favicon.ico.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for automl_sphinx_theme-0.1.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf197abc1c6f903a85e1a478d3e361bfe4fcc7295f4b4ce29c30a3fed7dc1d51 |
|
MD5 | 3edb52695080557188f8193c3a540da2 |
|
BLAKE2b-256 | 5f383d59ff2fbc0a9fefa6271b827de3ace384e3a4b70eb71cb62d5e8523e5c9 |