AutoML Theme for Sphinx
Project description
AutoML Sphinx Theme
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
Close
Hashes for automl_sphinx_theme-0.1.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee27063ff4b6458a8082efd62075e9867a27293ca748acdcb9325d1403aefdb5 |
|
MD5 | f54d2ba408dfe34b3de71509e1dd9f00 |
|
BLAKE2b-256 | 076a58ed796dff88a5346cccad528fe240af7f0fca485ef28a7dcdaba7f7ae27 |