this repo has no description
more sphinx wrangling
+55
-10
Makefile
docs/Makefile
Makefile
docs/Makefile
+9
README.md
+9
README.md
+2
-2
conf.py
docs/conf.py
+2
-2
conf.py
docs/conf.py
···
14
14
# -- General configuration ---------------------------------------------------
15
15
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16
16
17
-
extensions = ['sphinx.ext.autodoc']
17
+
extensions = ['sphinx.ext.autodoc', 'sphinx_rtd_theme']
18
18
19
19
templates_path = ['_templates']
20
20
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
···
24
24
# -- Options for HTML output -------------------------------------------------
25
25
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
26
26
27
-
html_theme = 'alabaster'
27
+
html_theme = 'sphinx_rtd_theme'
28
28
html_static_path = ['_static']
docs/_static/.gitkeep
docs/_static/.gitkeep
This is a binary file and will not be displayed.
+35
docs/make.bat
+35
docs/make.bat
···
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
-3
index.rst
docs/index.rst
-3
index.rst
docs/index.rst
+5
-1
pyproject.toml
+5
-1
pyproject.toml
+4
-4
src/atmst/mst.py
+4
-4
src/atmst/mst.py
···
26
26
@dataclass(frozen=True) # frozen == immutable == win
27
27
class MSTNode:
28
28
"""
29
-
k/v pairs are interleaved between subtrees like so:
29
+
k/v pairs are interleaved between subtrees like so: ::
30
30
31
-
keys: (0, 1, 2, 3)
32
-
vals: (0, 1, 2, 3)
33
-
subtrees: (0, 1, 2, 3, 4)
31
+
keys: (0, 1, 2, 3)
32
+
vals: (0, 1, 2, 3)
33
+
subtrees: (0, 1, 2, 3, 4)
34
34
35
35
If a method is implemented in this class, it's because it's a function/property
36
36
of a single node, as opposed to a whole tree