docs/js: Split the documentation between the Python and JavaScript APIs

azure-pipelines.yml

@@ -22,6 +22,7 @@ steps:
     pip install -r ./docs/requirements.txt
     pip install pytest-azurepipelines
     npm --prefix ./js install
+    npm --prefix ./docs install
   displayName: 'Install dependencies'
 
 - script: |

docs/.gitignore

@@ -5,3 +5,6 @@ __pycache__/
 
 # Sphinx documentation
 _build/
+
+# Dependency directories
+node_modules/

docs/JavaScript/Alignment.rst

@@ -0,0 +1,5 @@
+Alignment
+=========
+
+.. js:autoclass:: Alignment
+    :members:

docs/JavaScript/BiString.rst

@@ -0,0 +1,5 @@
+BiString
+========
+
+.. js:autoclass:: BiString
+    :members:

docs/JavaScript/BiStringBuilder.rst

@@ -0,0 +1,5 @@
+BiStringBuilder
+===============
+
+.. js:autoclass:: BiStringBuilder
+    :members:

docs/JavaScript/Tokenization.rst

@@ -0,0 +1,8 @@
+Tokenization
+============
+
+.. js:autoclass:: Token
+    :members:
+
+.. js:autoclass:: Tokenization
+    :members:

docs/JavaScript/Tokenizer.rst

@@ -0,0 +1,11 @@
+Tokenizer
+=========
+
+.. js:autoclass:: Tokenizer
+    :members:
+
+.. js:autoclass:: RegExpTokenizer
+    :members:
+
+.. js:autoclass:: SplittingTokenizer
+    :members:

docs/JavaScript/index.rst

@@ -0,0 +1,10 @@
+JavaScript
+==========
+
+.. toctree::
+
+    BiString
+    BiStringBuilder
+    Alignment
+    Tokenization
+    Tokenizer

docs/Python/index.rst

@@ -0,0 +1,11 @@
+Python
+======
+
+.. toctree::
+
+    bistr
+    BistrBuilder
+    Alignment
+    Tokenization
+    Tokenizer
+

docs/conf.py

@@ -12,10 +12,9 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+
+import os
+from pathlib import Path
 
 
 # -- Project information -----------------------------------------------------
@@ -38,6 +37,7 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx_autodoc_typehints',
+    'sphinx_js',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -46,12 +46,23 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    'node_modules',
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+]
+
+
+# -- Intersphinx configuration -----------------------------------------------
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
 }
 
+
+# -- Autodoc configuration ---------------------------------------------------
+
 autoclass_content = 'both'
 
 autodoc_default_options = {
@@ -64,6 +75,20 @@
 autodoc_inherit_docstrings = False
 
 
+# -- sphinx-js configuration -------------------------------------------------
+
+npm_bin = str((Path(__file__).parent/'node_modules/.bin').resolve())
+os.environ["PATH"] = npm_bin + ":" + os.environ["PATH"]
+
+js_language = 'typescript'
+
+js_source_path = '../js/src'
+
+jsdoc_config_path = '../js/tsconfig.json'
+
+root_for_relative_js_paths = '..'
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

docs/index.rst

@@ -5,16 +5,13 @@ The bistring library provides non-destructive versions of common string processi
 Each bistring remembers the original string, and how its substrings map to substrings of the modified version.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+    :maxdepth: 2
+    :caption: Contents:
 
-   Introduction
-   FAQ
-   bistr
-   BistrBuilder
-   Alignment
-   Tokenization
-   Tokenizer
+    Introduction
+    FAQ
+    Python/index
+    JavaScript/index
 
 
 Indices and tables