Skip to content

Commit 32f0cc2

Browse files
Merge pull request #343 from terminusdb/doc_typos
Doc typos and new doc generation
2 parents 1c4e0f0 + 77e3390 commit 32f0cc2

18 files changed

+47
-640
lines changed

.github/workflows/docs.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,25 @@ jobs:
2020
python-version: '3.x'
2121
- name: Generate docs
2222
run: |
23+
git clone --single-branch --branch add_gitbook https://github.com/terminusdb/pydoc-markdown.git
2324
python -m pip install --upgrade pip
25+
pip install ./pydoc-markdown
26+
pydoc-markdown
2427
cd docs
2528
python -m pip install -r requirements.txt
2629
make markdown
30+
python generateGitbookMD.py
31+
cp -r reference/* build/markdown/gitbook-md/
2732
- name: Set destination BRANCH_NAME for docs repo
2833
run: echo "BRANCH_NAME=Python-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
2934
- name: Create pull request in terminusdb/terminusdb-docs
3035
uses: paygoc6/action-pull-request-another-repo@v1.0.1
3136
env:
3237
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
3338
with:
34-
source_folder: 'docs/build/markdown/.'
39+
source_folder: 'docs/build/markdown/gitbook-md'
3540
destination_repo: 'terminusdb/terminusdb-docs'
36-
destination_folder: 'index/terminusx-db/reference-guides/python-client-reference'
41+
destination_folder: 'guides/reference-guides/python-client-reference'
3742
destination_base_branch: 'main'
3843
destination_head_branch: ${{ env.BRANCH_NAME }}
3944
user_email: 'robin@terminusdb.com'

docs/make.bat

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

docs/source/Scaffolding_CLI_Tool.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Scaffolding CLI Tool
2+
====================
3+
4+
5+
.. click:: terminusdb_client.scripts.scripts:tdbpy
6+
:prog: tdbpy
7+
:nested: full

docs/source/index.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
.. terminusdb_client documentation master file, created by
2-
sphinx-quickstart on Tue Aug 23 15:24:49 2022.
1+
.. TerminusDB Client documentation master file, created by
2+
sphinx-quickstart on Tue Jan 21 16:42:57 2020.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to terminusdb_client's documentation!
7-
=============================================
6+
TerminusDB Client's documentation
7+
======================================
88

99
.. toctree::
1010
:maxdepth: 4
1111
:caption: Contents:
1212

13-
terminusdb_client
13+
Scaffolding_CLI_Tool
14+
1415

1516

1617
Indices and tables
@@ -19,3 +20,4 @@ Indices and tables
1920
* :ref:`genindex`
2021
* :ref:`modindex`
2122
* :ref:`search`
23+

docs/source/terminusdb_client.client.rst

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

docs/source/terminusdb_client.rst

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

docs/source/terminusdb_client.schema.rst

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

docs/source/terminusdb_client.scripts.rst

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

docs/source/terminusdb_client.tests.integration_tests.rst

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

0 commit comments

Comments
 (0)