Install the Awesome Theme as a Python package, copy it into a local directory, or install the development dependencies to create your own theme.
Install the latest released version from the Python Package Index PyPI:
pip install sphinxawesome-theme
You can also install the latest development version:
pip install git+https://github.com/kai687/sphinxawesome-theme.git
See the CHANGELOG file for extra features and updates in the development version that aren’t released yet.
If you want to add styles or extra templates, see customize the theme.
If you want to modify the theme, you can clone the repository and install the cloned version as local Python package.
To install the local version of the theme in your project:terminal
pip install --editable /path/to/sphinxawesome_theme
/path/to/sphinxawesome_themewith the path to your local directory with the theme (the directory with the
--editableoption installs the package in editable, or development, mode.
To modify the theme, create a local copy:
Optional: fork the repository.
If you don’t want to merge your changes with the original repository, you can skip this step.
Clone the repository:
If you forked the repository, enter:terminal
git clone https://github.com/GITHUB_USERNAME/sphinxawesome-theme.git
GITHUB_USERNAMEwith your GitHub username.
If you didn’t fork the repository, clone the original repository:terminal
git clone https://github.com/kai687/sphinxawesome-theme.git
The commands below install the latest versions of Nox and Poetry. In case of a version conflict, see the file constraints.txt for the version numbers used when building the Awesome Theme Python package.
Follow these steps to install the Python dependencies:
pip install --user --upgrade nox
Install the Python dependencies:terminal
Optional: install and test the pre-commit hooks:terminal
poetry run pre-commit install
If you don’t plan on committing any changes to the repository, you can skip this step. You can see the active pre-commit hooks in the file .pre-commit-config.yaml.
To test pre-commit with Poetry, run:terminal
poetry run pre-commit run --all
Test your Nox environment.
You can run any Nox session to confirm that the environment is working. To list the available sessions, enter:terminal
For example, to build the documentation with Python 3.10, enter:terminal
nox -s docs -p 3.10
Confirm that Node.js is installed:text
$ node --version v10.24.1
If the preceding command fails, make sure that you installed Node.js. If you installed Node.js, make sure that the path to the
nodeexecutable is in your
npm install --global yarn
Go to the
./sphinxawesome-theme/ ├── src/ │ ├── sphinxawesome_theme/ │ └── theme-src/ ├── docs/ ├── tests/ └── ...
Build the theme:terminal