-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f57a25f
commit 8c0d8a3
Showing
1 changed file
with
2 additions
and
37 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 |
---|---|---|
@@ -1,41 +1,6 @@ | ||
Sphinx Docs Tutorial | ||
===================== | ||
|
||
will solve your problem of where to start with documentation, | ||
by providing a basic explanation of how to do it easily. | ||
By going over the [Sphinx Docs](https://www.sphinx-doc.org/en/master/) to learn how to document my python code I ended up making a tutorial for myself using the tool. | ||
|
||
Look how easy it is to use: | ||
|
||
import project | ||
# Get your stuff done | ||
project.do_stuff() | ||
|
||
Features | ||
-------- | ||
|
||
- Be awesome | ||
- Make things faster | ||
|
||
Installation | ||
------------ | ||
|
||
Install $project by running: | ||
|
||
install project | ||
|
||
Contribute | ||
---------- | ||
|
||
- Issue Tracker: github.com/$project/$project/issues | ||
- Source Code: github.com/$project/$project | ||
|
||
Support | ||
------- | ||
|
||
If you are having issues, please let us know. | ||
We have a mailing list located at: project@google-groups.com | ||
|
||
License | ||
------- | ||
|
||
The project is licensed under the BSD license. | ||
The source files included in this tutorial shows how to start documenting your projects without getting deep into more advanced stuff like modifying the theme or making extensions for Sphinx. |