The resources for generating https://scientificcomputing.github.io/.
To contribute, please make a fork of the repository and clone it to your local system, then make a new branch with
git checkout -b name_of_author/describe_feature
Then add the relevant text. Next ensure that the webpage builds, this can be done with
python3 -m venv sc_webpage_env
source sc_webpage_env/bin/activate
python3 -m pip install .
python3 -m jupyter book build -W ./docs
Inspect the webpage locally by opening ./docs/_build/html/index.html
and navigating to the appropriate page.
Before you push the changes, ensure that the text is properly formatted, run
pre-commit
Then, make corrections and commit any changes before re-running pre-commit.
Push the branch to your fork, and then make a pull request through the github web-interface.