File tree Expand file tree Collapse file tree 4 files changed +102
-0
lines changed Expand file tree Collapse file tree 4 files changed +102
-0
lines changed 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
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
+
6
+ # -- Project information -----------------------------------------------------
7
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8
+
9
+ project = 'Signal Documentation'
10
+ copyright = '2023, cmu.edu'
11
+ author = 'cmu.edu'
12
+ release = '1.0.0'
13
+
14
+ # -- General configuration ---------------------------------------------------
15
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16
+
17
+ extensions = []
18
+
19
+ templates_path = ['_templates' ]
20
+ exclude_patterns = []
21
+
22
+
23
+ # -- Options for HTML output -------------------------------------------------
24
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
25
+
26
+ html_theme = 'alabaster'
27
+ html_static_path = ['_static' ]
Original file line number Diff line number Diff line change
1
+ .. Signal Documentation documentation master file, created by
2
+ sphinx-quickstart on Thu Oct 26 14:23:29 2023.
3
+ You can adapt this file completely to your liking, but it should at least
4
+ contain the root `toctree` directive.
5
+
6
+ Welcome to Signal Documentation's documentation!
7
+ ================================================
8
+
9
+ .. toctree ::
10
+ :maxdepth: 2
11
+ :caption: Contents:
12
+
13
+
14
+
15
+ Indices and tables
16
+ ==================
17
+
18
+ * :ref: `genindex `
19
+ * :ref: `modindex `
20
+ * :ref: `search `
You can’t perform that action at this time.
0 commit comments