Skip to content

Commit 34c149b

Browse files
committed
Adjusts documentation setup guide.
1 parent d08fa2f commit 34c149b

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ __pycache__/
1010
.Python
1111
env/
1212
build/
13+
docs/build/
14+
docs/docs_html/
1315
develop-eggs/
1416
dist/
1517
downloads/
@@ -24,6 +26,7 @@ wheels/
2426
*.egg-info/
2527
.installed.cfg
2628
*.egg
29+
ads_latest.zip
2730

2831
# PyInstaller
2932
# Usually these files are written by a python script from a template

docs/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Documentation
2+
3+
## Getting Started
4+
5+
Setup Conda.
6+
7+
Download the latest Miniconda installer for your machine from here: https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links
8+
9+
For example for linux you can run the script below:
10+
11+
```bash
12+
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -o Miniconda3-latest-Linux-x86_64.sh
13+
bash Miniconda3-latest-Linux-x86_64.sh
14+
```
15+
16+
Create conda environment.
17+
18+
```bash
19+
conda create -n ads-docs python=3.8
20+
conda activate ads-docs
21+
```
22+
23+
Install relevant development packages.
24+
25+
```bash
26+
pip install -r requirements.txt
27+
```
28+
29+
## Developing Docs With Live Reload
30+
31+
Start live-reload during the development face
32+
33+
```bash
34+
sphinx-autobuild source/ build/
35+
```
36+
37+
Open in the browser [http://127.0.0.1:8000]
38+
39+
## Build
40+
41+
To build and create the html documentation, run the following in the `docs/` folder.
42+
43+
```bash
44+
sphinx-build -b html source/ docs_html/
45+
```
46+
47+
To `zip` the content of the html docs
48+
49+
```bash
50+
zip -r ads-latest.zip docs_html/.
51+
```
52+
53+
## Notes
54+
55+
- the `source/conf.py` defines most everything for the docs
56+
- the `ads.rst` was auto-generated but then hand edited to remove tests package
57+
58+
## Contribute
59+
60+
Now you can make updates to the docs and contributed via PRs.

0 commit comments

Comments
 (0)