SPEBT Project Documentation

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 recommend 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:

   https://github.com/spebt/spebt.github.io

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

Tip

Popular editors:

• Visual Studio Code
• Neovim

1. Run the following command to build the website:

   make html

2. 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