forked from beeware/voc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request beeware#954 from freakboy3742/contribution
Add docs contribution guide.
- Loading branch information
Showing
3 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,3 +21,4 @@ tests/tmp* | |
|
||
.DS_Store | ||
.idea/ | ||
.vscode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.