Add Sphinx docs setup.
parent
7ada79bb7a
commit
ebc4fa2e77
|
@ -149,3 +149,16 @@ codeql
|
||||||
**/**/.idea
|
**/**/.idea
|
||||||
**/**/.qodana
|
**/**/.qodana
|
||||||
**/**/build
|
**/**/build
|
||||||
|
.~lock.*.ods#
|
||||||
|
.pytest_cache/
|
||||||
|
.python-version
|
||||||
|
|
||||||
|
build
|
||||||
|
env
|
||||||
|
tmp
|
||||||
|
venv
|
||||||
|
*.swp
|
||||||
|
**/dist/
|
||||||
|
**/*.egg-info/
|
||||||
|
*/target/
|
||||||
|
__pycache__
|
||||||
|
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line, and also
|
||||||
|
# from the environment for the first two.
|
||||||
|
SPHINXOPTS ?=
|
||||||
|
SPHINXBUILD ?= sphinx-build
|
||||||
|
SOURCEDIR = source
|
||||||
|
BUILDDIR = build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@ -0,0 +1,12 @@
|
||||||
|
project = "Parrot Extension"
|
||||||
|
copyright = "2023, Jeff Moe"
|
||||||
|
author = "Jeff Moe"
|
||||||
|
release = "v0.0.3"
|
||||||
|
extensions = [
|
||||||
|
"sphinx.ext.autodoc",
|
||||||
|
]
|
||||||
|
templates_path = ["_templates"]
|
||||||
|
exclude_patterns = ["_build"]
|
||||||
|
html_theme = "sphinx_rtd_theme"
|
||||||
|
html_static_path = ["_static"]
|
||||||
|
htmlhelp_basename = "ParrotExtensiondoc"
|
|
@ -0,0 +1,9 @@
|
||||||
|
Parrot Extension
|
||||||
|
================
|
||||||
|
Extension for Parrot Libre AI IDE.
|
||||||
|
|
||||||
|
This is under development.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:caption: Contents:
|
|
@ -0,0 +1,6 @@
|
||||||
|
sphinx
|
||||||
|
sphinx-rtd-theme
|
||||||
|
sphinx-autodoc-typehints
|
||||||
|
sphinxcontrib-markdown
|
||||||
|
sphinx-autobuild
|
||||||
|
sphinx-intl
|
Loading…
Reference in New Issue