diff --git a/doc/contributing.rst b/doc/contributing.rst index 0bf969b6..2d025382 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -35,3 +35,16 @@ including our own are reviewed by a second person before they are incorporated i If you are unfamiliar with pull requests, the GitHub help pages have a nice `guide `_. To ask and answer general usage questions, join the `PyPSA mailing list `_. + +Contributing to the documentation +==================================== + +We strive to keep documentation useful and up to date for all PyPSA users. If you encounter an area where documentation is not available or insufficient, we very much welcome your contribution. Here is How To: + +#. Install the conda environment for documentation from the `PyPSA repository `_. + (Here is `how to install a conda environment `_.) +#. Make your changes in the corresponding .rst file under ``pypsa-eur/doc``. +#. Compile your changes by running the following command in your terminal in the ``doc`` folder: ``make html`` + You may encounter some warnings, but end up with a message such as ``build succeeded, XX warnings.``. html files to review your changes can then be found under ``doc/_build/html``. +#. Contribute your documentation in a pull request (`here is a guide `_). + \ No newline at end of file diff --git a/doc/release_notes.rst b/doc/release_notes.rst index b782a6df..c5099943 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -176,6 +176,8 @@ Upcoming Release * Fix custom busmap read in `cluster_network`. +* Add documentation section for how to contribute documentation + PyPSA-Eur 0.10.0 (19th February 2024) =====================================