File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -26,6 +26,7 @@ share/python-wheels/
2626.installed.cfg
2727* .egg
2828MANIFEST
29+ _version.py
2930
3031# PyInstaller
3132# Usually these files are written by a python script from a template
Original file line number Diff line number Diff line change 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 = source
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 )
Original file line number Diff line number Diff line change 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 = source
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
Original file line number Diff line number Diff line change 22shibuya
33sphinx-copybutton
44sphinx-design
5- sphinx-tabs
5+ sphinx-tabs
6+ setuptools_scm
Original file line number Diff line number Diff line change 1+ # Configuration file for the Sphinx documentation builder.
2+ #
3+ # For the full list of built-in configuration values, see the documentation:
4+ # https://www.sphinx-doc.org/en/master/usage/configuration.html
5+ import sys
6+ import pathlib
7+ import setuptools_scm
8+
9+ PROJECT_ROOT = pathlib .Path (__file__ ).parent .parent .parent
10+
11+ sys .path .insert (0 , str (PROJECT_ROOT / "src" ))
12+
13+ # -- Project information -----------------------------------------------------
14+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
15+ project = "icspacket"
16+ copyright = "2025, MatrixEditor"
17+ author = "MatrixEditor"
18+ release = setuptools_scm .get_version (str (PROJECT_ROOT ))
19+
20+ # -- General configuration ---------------------------------------------------
21+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
22+ extensions = [
23+ "sphinx.ext.autodoc" ,
24+ "sphinx.ext.extlinks" ,
25+ "sphinx.ext.todo" ,
26+ "sphinx.ext.viewcode" ,
27+ "sphinx.ext.autosummary" ,
28+ "sphinx_copybutton" ,
29+ "sphinx_design" ,
30+ "sphinx_tabs.tabs" ,
31+ ]
32+
33+ templates_path = ["_templates" ]
34+ exclude_patterns = []
35+
36+
37+ # -- Options for HTML output -------------------------------------------------
38+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
39+ html_theme = "shibuya"
40+ html_static_path = ["_static" ]
41+
42+ html_copy_source = False
43+ html_show_sourcelink = False
Original file line number Diff line number Diff line change 1+ .. _icspacket_index :
You can’t perform that action at this time.
0 commit comments