this repo has no description
spinx docs skeleton
+67
+3
.gitignore
+3
.gitignore
+20
Makefile
+20
Makefile
···
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)
+28
conf.py
+28
conf.py
···
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 = 'atmst'
10
+
copyright = '2024, David Buchanan'
11
+
author = 'David Buchanan'
12
+
release = '0.0.1'
13
+
14
+
# -- General configuration ---------------------------------------------------
15
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16
+
17
+
extensions = ['sphinx.ext.autodoc']
18
+
19
+
templates_path = ['_templates']
20
+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
21
+
22
+
23
+
24
+
# -- Options for HTML output -------------------------------------------------
25
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
26
+
27
+
html_theme = 'alabaster'
28
+
html_static_path = ['_static']
+16
index.rst
+16
index.rst
···
1
+
Welcome to atmst's documentation!
2
+
=================================
3
+
4
+
.. automodule:: atmst.mst
5
+
:members:
6
+
7
+
.. toctree::
8
+
:maxdepth: 2
9
+
:caption: Contents:
10
+
11
+
Indices and tables
12
+
==================
13
+
14
+
* :ref:`genindex`
15
+
* :ref:`modindex`
16
+
* :ref:`search`