1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# assertpy docs
Documentation is mostly written inline using Python docstrings that are in
[Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) format.
[Sphinx](https://www.sphinx-doc.org/) and the
[Napoleon extension](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html)
are used to generate html.
## Setup
Install `sphinx` via pip...
```
pip install sphinx
pip install sphinxcontrib-napoleon
```
And checkout the [assertpy.github.io](https://github.com/assertpy/assertpy.github.io)
repo as a sibling to `assertpy`.
```
cd ..
git clone git@github.com:assertpy/assertpy.github.io.git
```
## Build
To build the docs, run:
```
cd docs/
./build.sh
```
This generates `docs.html` and copies is directly into the sibling
`assertpy.github.io` repo.
|
