Skip to content

Commit ab5fe56

Browse files
rrooijrrooij
committed
Update docs again
1 parent 4c9dd60 commit ab5fe56

15 files changed

+646
-7
lines changed

‎.github/workflows/docs.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,14 @@ jobs:
2424
cd docs
2525
python -m pip install -r requirements.txt
2626
make markdown
27-
python generateGitbookMD.py
2827
- name: Set destination BRANCH_NAME for docs repo
2928
run: echo "BRANCH_NAME=Python-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
3029
- name: Create pull request in terminusdb/terminusdb-docs
3130
uses: paygoc6/action-pull-request-another-repo@v1.0.1
3231
env:
3332
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
3433
with:
35-
source_folder: 'docs/build/markdown/gitbook-md/.'
34+
source_folder: 'docs/build/markdown/.'
3635
destination_repo: 'terminusdb/terminusdb-docs'
3736
destination_folder: 'index/terminusx-db/reference-guides/python-client-reference'
3837
destination_base_branch: 'main'

‎docs/generateGitbookMD.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
# * https://terminusdb.com/docs/index/terminusx-db/reference-guides/python-client-reference
1515
# *
1616

17+
import glob
1718
import re
1819
import os
1920

@@ -147,13 +148,12 @@ def _md(line, nL = 0):
147148
print(error)
148149

149150
# Loop through each file for conversion
150-
for f in f_input:
151-
file = open(f_dir+f+'.md',"r")
151+
for f in glob.glob('./build/markdown/*.md'):
152+
print(f)
153+
file = open(f, "r")
152154
file_data = file.read()
153155

154-
f_md = open(path+"/"+f+'.md', "w")
155-
156-
f = f_dir+f+'.md'
156+
f_md = open(f, "w")
157157

158158
process_data = ""
159159
if re.search("Scaffolding", f):

‎docs/source/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/terminusdb_client.client.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
terminusdb\_client.client package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
terminusdb\_client.client.Client module
8+
---------------------------------------
9+
10+
.. automodule:: terminusdb_client.client.Client
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: terminusdb_client.client
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/terminusdb_client.rst

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
terminusdb\_client package
2+
==========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
terminusdb_client.client
11+
terminusdb_client.schema
12+
terminusdb_client.scripts
13+
terminusdb_client.tests
14+
terminusdb_client.woqlclient
15+
terminusdb_client.woqldataframe
16+
terminusdb_client.woqlquery
17+
terminusdb_client.woqlschema
18+
19+
Submodules
20+
----------
21+
22+
terminusdb\_client.errors module
23+
--------------------------------
24+
25+
.. automodule:: terminusdb_client.errors
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
terminusdb\_client.woql\_type module
31+
------------------------------------
32+
33+
.. automodule:: terminusdb_client.woql_type
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
terminusdb\_client.woql\_utils module
39+
-------------------------------------
40+
41+
.. automodule:: terminusdb_client.woql_utils
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
Module contents
47+
---------------
48+
49+
.. automodule:: terminusdb_client
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:

‎docs/source/terminusdb_client.schema.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
terminusdb\_client.schema package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
terminusdb\_client.schema.schema module
8+
---------------------------------------
9+
10+
.. automodule:: terminusdb_client.schema.schema
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: terminusdb_client.schema
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/terminusdb_client.scripts.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
terminusdb\_client.scripts package
2+
==================================
3+
4+
Submodules
5+
----------
6+
7+
terminusdb\_client.scripts.schema\_template module
8+
--------------------------------------------------
9+
10+
.. automodule:: terminusdb_client.scripts.schema_template
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
terminusdb\_client.scripts.scripts module
16+
-----------------------------------------
17+
18+
.. automodule:: terminusdb_client.scripts.scripts
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: terminusdb_client.scripts
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/terminusdb_client.tests.integration_tests.rst

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
terminusdb\_client.tests.integration\_tests package
2+
===================================================
3+
4+
Submodules
5+
----------
6+
7+
terminusdb\_client.tests.integration\_tests.conftest module
8+
-----------------------------------------------------------
9+
10+
.. automodule:: terminusdb_client.tests.integration_tests.conftest
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
terminusdb\_client.tests.integration\_tests.mock\_jsons module
16+
--------------------------------------------------------------
17+
18+
.. automodule:: terminusdb_client.tests.integration_tests.mock_jsons
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
terminusdb\_client.tests.integration\_tests.test\_client module
24+
---------------------------------------------------------------
25+
26+
.. automodule:: terminusdb_client.tests.integration_tests.test_client
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
terminusdb\_client.tests.integration\_tests.test\_schema module
32+
---------------------------------------------------------------
33+
34+
.. automodule:: terminusdb_client.tests.integration_tests.test_schema
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
terminusdb\_client.tests.integration\_tests.test\_scripts module
40+
----------------------------------------------------------------
41+
42+
.. automodule:: terminusdb_client.tests.integration_tests.test_scripts
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: terminusdb_client.tests.integration_tests
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

0 commit comments

Comments
 (0)