Skip to content

Commit a997adf

Browse files
Merge pull request #5 from nxt-dev/api_docs_prep
Cleanup from split and prepare for updated deploy from user docs
2 parents 863482a + c1f2849 commit a997adf

File tree

8 files changed

+2
-310
lines changed

8 files changed

+2
-310
lines changed

docs/api_docs/Makefile

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

docs/api_docs/api_docs.md

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

docs/api_docs/docs_env.yml

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

docs/api_docs/make.bat

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

docs/api_docs/source/conf.py

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

docs/api_docs/source/index.rst

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

docs/doc_setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ To deploy a total package updated docs build:
1414

1515
6. Clean up after yourself. `git clean -f -d`
1616

17-
For greater details on either the user or api docs, see [user_docs.md](user_docs/user_docs.md), and [api_docs.md](api_docs/api_docs.md)
17+
For detailed steps on either the user or api docs, see [user_docs.md](user_docs/user_docs.md), and [api_docs.md](https://github.com/nxt-dev/nxt/blob/release/docs/api_docs.md)

docs/user_docs/user_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ https://www.mkdocs.org/
66
# Setup
77
1. Create a conda environment based on nxt_user_docs_env.yml; `nxtuserdocs`
88
2. Launch anaconda shell, `conda activate nxtuserdocs`
9-
3. Navigate to `~/project/nxt/docs/user_docs/`, run `mkdocs serve`
9+
3. Navigate to `nxt-dev.github.io/docs/user_docs/`, run `mkdocs serve`
1010
4. point your brower to: http://127.0.0.1:8000/
1111

1212
# Theme

0 commit comments

Comments
 (0)