diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 0000000..5d9fabc --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1,14 @@ +.. _contribute: + +Contribute +========== + +We welcome contributions to setvis! Please use the github issue tracker to report bugs or request features. If you would like to contribute code, please fork the repository and submit a pull request. + +We do not have a set of standard workflow to develop setvis so you are welcome to use your own workflow. + +You do not need to be a developer to contribute to setvis. We welcome contributions of documentation, bug reports, and feature requests. + +To use GitHub to contribute, and you could contribute outside of GitHub, and if you do not have any experience with GitHub, you can learn how to use it by following the `GitHub Getting Started Guide `_. + +If you are looking to find the documentation to generate the documentation of setvis locally, see :ref:`setvis documentation `. diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst index 5445ac5..a1b8289 100644 --- a/docs/source/documentation.rst +++ b/docs/source/documentation.rst @@ -1,7 +1,9 @@ -Contributors -============ +.. _setvis-documentation: -This section contains information useful for anyone planning to contribute to setvis. +setvis documentation +==================== + +This section contains information useful for anyone planning to generate the documentation of setvis locally. Generating documentation locally -------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 5c8a963..4a1b356 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,9 +33,10 @@ Contents :maxdepth: 2 installation + api_reference tutorials documentation - api_reference + contributing Introductory Example ====================