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!
💖 You're welcome. 💖

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.

Version Switching

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.

Customization

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

Metadata

Release files for automl-sphinx-theme 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for automl-sphinx-theme 0.2.0
File	Size	Uploaded	Provenance
automl_sphinx_theme-0.2.0.tar.gz	1.4 MB	Oct 19, 2022	Without provenance	Details

Release files / automl_sphinx_theme-0.2.0.tar.gz

Download URL	automl_sphinx_theme-0.2.0.tar.gz
Size	1.4 MB
Tags	Source
SHA-256 checksum How to use checksums	`cd6924610cbc5706ae874eeef36645f88c503a3cfd4ad02e0fe763cc8e95dccf`
BLAKE2b-256 checksum How to use checksums	`bec33a6a7c3f4529b5e8174ddb8c2ef70dbd74ed2ee5de7e16ddd9cb43d9ffc0`
Upload date	Oct 19, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.4`

Security for automl-sphinx-theme 0.2.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.