Skip to content

Commit 247f9b8

Browse files
authored
DOC: Updating documentation (#865)
Many updates to RTD documentation
1 parent 9e3f8ac commit 247f9b8

22 files changed

+146
-798
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ instance/
9494

9595
# Sphinx documentation
9696
docs/_build/
97+
docs/src/
98+
docs/source/api/
9799

98100
# PyBuilder
99101
target/
@@ -128,4 +130,4 @@ ENV/
128130
/site
129131

130132
# mypy
131-
.mypy_cache/
133+
.mypy_cache/

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Building the docs
2+
3+
To build docs locally:
4+
5+
```
6+
sphinx-build -b html docs/source docs/_build/html
7+
```

docs/source/ants.core.rst

Lines changed: 0 additions & 62 deletions
This file was deleted.

docs/source/ants.learn.rst

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/source/ants.lib.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/source/ants.registration.rst

Lines changed: 0 additions & 118 deletions
This file was deleted.

docs/source/ants.rst

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/source/ants.segmentation.rst

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)