Sphinx Theme for documentation sites.
Project description
A minimalist Bootstrap-based HTML5 theme for Sphinx. For generating documentation sites.
Check the latest docs to find out how to set it up.
The skin has been adapted from the static template Docs Bootstrap Template, and it is the visual reference to be followed by the project.
Features
Minimalist and reactive look
Font Awesome icons
highlight.js for syntax highlighting
Prepared for Facebook’s Open Graph and Twitter Cards
Demo
To check the Sphinx Docs Theme at work take a look at the documentation, linked below this section, which is created with Sphinx and making use of this theme.
Documentation
Documentation sources are included with the project, and used to generate the documentation sites:
The latest docs are always generated for the latest release, kept in the ‘master’ branch
The development docs are generated from the latest code in the ‘develop’ branch
The source files for the docs, a small Sphinx project, are kept in the ‘docs folder.
These can be built if needed:
python setup.py build_docs
Usage
The project is a Sphinx theme, which can be used in a similar way to any other such theme.
Prerequisites
Sphinx is required to make use of this theme, as it is meant to be integrated into a Sphinx project. To find more information about this check its webpage, which will also tell which Python interpreters can be used.
All other Python dependencies are indicated on the requirements.txt file.
These dependencies can be installed with:
pip install --upgrade -r requirements.txt
The frontend libraries are defined as npm dependencies, and require this package manager to be defined.
These dependencies can be installed with:
python setup.py frontend
Installing
The project is offered as a Pypi package, and using pip is the preferred way to install it. For this use the following command;
pip install sphinx-docs-theme
If needed, manual installation is possible:
python setup.py install
Using it as a dependency
If the project has been installed in the local libraries repository, it can be used just by adding the following lines to the conf.py file of any Sphinx project:
import sphinx_docs_theme
html_theme = 'sphinx_docs_theme'
html_theme_path = sphinx_docs_theme.get_html_theme_path()
Using it from the Sphinx themes folder
Another possibility is just adding the project code, contained int the ‘sphinx_docs_theme’ folder, to the themes folder of your Sphinx project, which is:
docs\_themes\sphinx_docs_theme\
And then it is just needed to add the following files to the conf.py file:
html_theme = 'sphinx_docs_theme'
html_theme_path = ["_themes", ]
Collaborate
Any kind of help with the project will be well received, and there are two main ways to give such help:
Reporting errors and asking for extensions through the issues management
or forking the repository and extending the project
Issues management
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
Getting the code
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the ‘master’ branch for the latest release, and the ‘develop’ for the current, and stable, development version.
License
The project has been released under the MIT License.
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
Built Distribution
File details
Details for the file sphinx-docs-theme-1.0.7.tar.gz
.
File metadata
- Download URL: sphinx-docs-theme-1.0.7.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 382e457feedad84eebe4e90d240401f5b2336df1e9d64baa0241739a19fd17f5 |
|
MD5 | cf16244212bef1451ebb4cd9f8e67c05 |
|
BLAKE2b-256 | 4754ff5dbf235314e830b8a4030d01caf7d33ab6ddf91a5925110d3c5f51d0e7 |
File details
Details for the file sphinx_docs_theme-1.0.7-py2.py3-none-any.whl
.
File metadata
- Download URL: sphinx_docs_theme-1.0.7-py2.py3-none-any.whl
- Upload date:
- Size: 1.2 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | de7de5b972d915e6324e5656cdb23ce232e5e2d027bfe8ab1b16775fd88097af |
|
MD5 | bb94ccd0bd6495c1fab783746cf7eb67 |
|
BLAKE2b-256 | 399f8c79da9c14ef08f7fde6d793c89046eb642a96c3c70012cf7f78230f641d |