Skip to content

Commit 9135ddb

Browse files
committed
Fix doc generation hopefully and fix typos
1 parent 02a080b commit 9135ddb

18 files changed

+30
-632
lines changed

.github/workflows/docs.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ name: Generate docs and Create PR on docs repo
55

66
on:
77
push:
8-
tags:
9-
- v*
108

119
jobs:
1210
make_docs:
@@ -20,20 +18,25 @@ jobs:
2018
python-version: '3.x'
2119
- name: Generate docs
2220
run: |
21+
git clone --single-branch --branch add_gitbook https://github.com/terminusdb/pydoc-markdown.git
2322
python -m pip install --upgrade pip
23+
pip install ./pydoc-markdown
24+
pydoc-markdown
2425
cd docs
2526
python -m pip install -r requirements.txt
2627
make markdown
28+
python generateGitbookMD.py
29+
cp -r reference/* build/markdown/gitbook-md/
2730
- name: Set destination BRANCH_NAME for docs repo
2831
run: echo "BRANCH_NAME=Python-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
2932
- name: Create pull request in terminusdb/terminusdb-docs
3033
uses: paygoc6/action-pull-request-another-repo@v1.0.1
3134
env:
3235
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
3336
with:
34-
source_folder: 'docs/build/markdown/.'
37+
source_folder: 'docs/build/markdown/gitbook-md'
3538
destination_repo: 'terminusdb/terminusdb-docs'
36-
destination_folder: 'index/terminusx-db/reference-guides/python-client-reference'
39+
destination_folder: 'guides/reference-guides/python-client-reference'
3740
destination_base_branch: 'main'
3841
destination_head_branch: ${{ env.BRANCH_NAME }}
3942
user_email: 'robin@terminusdb.com'

docs/make.bat

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

docs/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ typeguard
77
requests
88
tqdm
99
shed
10-
sphinx-markdown-builder

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)