Skip to content

Commit 5167d95

Browse files
committed
proof reading
1 parent b7ee379 commit 5167d95

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

readme.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ A template setup for a python project.
33

44
It contains the following:
55
1. Setting up a python package
6-
2. tests for unittest and integration testing
6+
2. Tests for unittest and integration testing
77
3. TravisCI for continuous integration
88
4. Generating documentation locally and on readthedocs.org built using Sphinx and Doxygen
99
5. Packaging the library for distribution on PyPi
@@ -82,12 +82,9 @@ also need to provide instructions on how to run your code just like you'd explai
8282

8383

8484
### 4. Generating Documentation
85-
You can only go so far without a good documentation. When there are large project release
86-
they make sure that they have a great documentation. It helps to build a user base around their library.
87-
As a library developer you can avoid lots of frustration to users and lots of effort on your part trying to resolve user issues
88-
by having a good documentation.
89-
90-
Here's how to generate good looking documentation on localhost.
85+
You can only go so far without good documentation. Great library developers make sure that they have great documentation. It helps to build a user base around the library.
86+
As a library developer, you can avoid lots of frustration to users and lots of effort on your part trying to resolve user issues by having good documentation.
87+
Here's how to generate good looking documentation on the localhost.
9188

9289
```
9390
cd docs
@@ -121,15 +118,16 @@ your package so that its files are reachable from conf.py.
121118
Path of my conf.py: docs/source/conf.py
122119

123120
Add these two statements so conf.py can access your package.
121+
124122
```
125123
import os
126124
import sys
127125
sys.path.insert(0, os.path.abspath('../..'))
128-
sys.path.insert(0, os.path.abspath('../..'))
126+
sys.path.insert(0, os.path.abspath('../python_project'))
129127
```
130128

131-
Extension tell doc generator what kind of stuffs to document and what not.
132-
For instance, sphinx.ext.viewcode provides link to the code code. Add the following to conf.py
129+
'extension' tells doc generator what kind of stuff to document and what to ignore.
130+
For instance, 'sphinx.ext.viewcode' generates link to the source code. Add the following to conf.py
133131

134132
```
135133
# First two are essential to generate the docs, others are optional.
@@ -146,12 +144,8 @@ extensions = [
146144

147145
We're done with the configuration. See the source code for [conf.py](docs/source/conf.py). I have done away with the boilerplate stuff and
148146

149-
docs/source/index.rst file is like the readme for the documentation. The changes you make to this file
150-
is seen in your documentation. In this file you define which python source file to document and which not to.
151-
You can include installation instructions, features, usage code snippets, etc in this file.
152-
153-
We built two libraries in this project: mathlib and strlib. We want both to be documented.
154-
So let's add that to the index.rst above "Indices and tables".
147+
docs/source/index.rst file is like the readme for the documentation. The changes you make to this file is seen in your generated documentation. In this file, you define which python source files to document. You can include installation instructions, features, usage code snippets, etc in this file.
148+
We built two libraries in this project: mathlib and strlib. We want both libs to be documented. So let's add that to the index.rst above "Indices and tables".
155149

156150
```
157151
Math Lib

0 commit comments

Comments
 (0)