Skip to content

Commit

Permalink
Update How to contribute.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
aylinsgl committed Dec 25, 2018
1 parent 200f297 commit 23c8a94
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions docs/How to contribute.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
How to contribute
=================

If you want to contribute to the documentation, either download or clone this
repository: https://github.com/VirtualDataLab/smobsc
and then access the "docs" directory. There you will find an index.rst file. This
is basically where you see the main structure of the documentation with all the
headers, subheaders etc. If you want to link to a new section, you have to add
it under toctree. When building the documentation sphinx will go through the
sections under toctree and look for .rst files with the same names in the docs
directory. Once you've added the section in the index.rst file and added the
corresponding .rst file in the docs directory, you can build the html with
"make html".
If you want to contribute to the documentation access the "docs" directory
in the repository https://github.com/VirtualDataLab/smobsc or simply chlick
the "edit on github" button on the top of this page. In the docs directory
you will find an index.rst file. This is basically where you see the main
structure of the documentation with all the headers, subheaders etc.
If you want to link to a new section, you have to add it under toctree.
When building the documentation sphinx will go through the sections under
toctree and look for .rst files with the same names in the docs directory.

0 comments on commit 23c8a94

Please sign in to comment.