About#

Sept 19, 2024

10 min read

Documentation Generation#

This website is generated by Sphinx with “PyData Sphinx Theme” required Python packages:

sphinx
pydata-sphinx-theme
sphinx_design
myst_parser

Develop the site locally#

Tip

  • For easy management of the Python packages, it is recommended to use a virtual environment.

  • I recommand using conda and Miniconda should be sufficient for this purpose.

  • Check out the Miniconda documentation for more information.

  1. Install the required Python packages:

    pip install sphinx pydata-sphinx-theme sphinx_design myst_parser

  2. Clone or download the website code from GitHub:

    spebt/spebt.github.io

  3. Change the contents as is needed with your favorite editor.

    Popular editors:

  4. Run the following command to build the website:

    make html

  5. Open the generated HTML index.html in the build directory with your browser (e.g. google chrome).

Deploy to GitHub page#

  • Use git to commit your tested changes and push to the remote repository.

  • GitHub Actions will take over the rest.

Contributors#

SPEBT GitHub Porject Contributors

On this page