Contributing to the documentation#
A great place to start contributing is to documentation. In order to do this you’ll want to run the docs locally. Here are the steps for getting setup.
Create a conda environment for the docs
Building the docs includes a few extra libraries that aren’t required for showyourwork! users, so its helpful to create a separate environment for those. You should only ever have to do this step once.
conda env create -n sywdocs -f docs/environment.yml
The remaining steps will be run every time you work on the documentation.
Activate the docs environment
conda activate sywdocs
Go into the documentation folder
Create the html from the reStructured Text (
Run a local file server of the docs website
python3 -m http.server -d _build/html
From here you can go to a web browser and open up the docs using the
port shown in terminal. (Ex.
The last two steps will need to be run every time you make a change in the
files and want to view them. Because of this it can be nice to run them together using
make html && python3 -m http.server -d _build/html
That’s the setup! Open documentation issues can be perused here .
Another great way to contribute is to raise or open issues. Showyourwork issues can be found in the github repo. The “contributions welcome” tag is a great place to start!