Skip to content

Commit

Permalink
Merge pull request beeware#954 from freakboy3742/contribution
Browse files Browse the repository at this point in the history
Add docs contribution guide.
  • Loading branch information
freakboy3742 authored Jun 26, 2019
2 parents 904af1b + f5b3971 commit 17b02ab
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ tests/tmp*

.DS_Store
.idea/
.vscode
36 changes: 36 additions & 0 deletions docs/how-to/contribute-docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Contributing to VOC's documentation
===================================

Here are some tips for working on this documentation. You're welcome to add
more and help us out!

First of all, you should check the `Restructured Text (reST) and Sphinx
CheatSheet <http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_ to
learn how to write your .rst file.

To create a .rst file
---------------------

Look at the structure and choose the best category to put your .rst file. Make
sure that it is referenced in the index of the corresponding category, so it
will show on in the documentation. If you have no idea how to do this, study
the other index files for clues.


To build locally on GNU/Linux and open it on the browser:
---------------------------------------------------------

Go to the documentation folder: ::

$ cd docs

Install Sphinx with the helpers and extensions we use: ::

$ pip install -r requirements_rtd.txt

Create the static files: ::

$ make html

Check for any errors and,if possible, fix them. The output of the file should
be in the ``_build/html`` folder. Open the file you changed in the browser.
File renamed without changes.

0 comments on commit 17b02ab

Please sign in to comment.