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 and examples directories to your root folder. You don't have to include all files but you should at least include docs/conf.py and docs/Makefile.
In docs/conf.py change src 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 the Makefile 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 select gh-pages as source.

Customization

Logo: Add docs/images/logo.png.
Favicon: Add docs/images/favicon.ico.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

automl_sphinx_theme-0.1.10.tar.gz (1.4 MB view details)

Uploaded May 18, 2022 Source

File details

Details for the file automl_sphinx_theme-0.1.10.tar.gz.

File metadata

Download URL: automl_sphinx_theme-0.1.10.tar.gz
Upload date: May 18, 2022
Size: 1.4 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for automl_sphinx_theme-0.1.10.tar.gz
Algorithm	Hash digest
SHA256	`1867fe146c07bff2e1f32bcaa445568ff025fa344c03a381b3e990c3ec22d78d`
MD5	`fc9749c785abdfa54fa7fce60a1425da`
BLAKE2b-256	`f37bd2c8d6d97ab0b4b2c3667f89221a13a52227c485ebdd6b4fdf5a03efb0c8`