Sphinx documentation for Parrot, stubs

main
root 2023-11-28 14:30:46 -07:00
parent aa0f90f2fc
commit 85910cb701
5 changed files with 60 additions and 0 deletions

12
.gitignore vendored
View File

@ -1,2 +1,14 @@
*.swp
tmp
.~lock.*.ods#
.pytest_cache/
.python-version
build
env
tmp
venv
*.swp
**/dist/
**/*.egg-info/
*/target/
__pycache__

20
docs/Makefile 100644
View File

@ -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)

View File

@ -0,0 +1,12 @@
project = "Parrot Libre AI IDE"
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 = "ParrotIDEdoc"

View File

@ -0,0 +1,10 @@
Parrot Libre AI IDE
===================
Documentation for Parrot Libre AI IDE.
There are no Parrot docs, at present.
It is under development.
.. toctree::
:maxdepth: 1
:caption: Contents:

6
requirements.txt 100644
View File

@ -0,0 +1,6 @@
sphinx
sphinx-rtd-theme
sphinx-autodoc-typehints
sphinxcontrib-markdown
sphinx-autobuild
sphinx-intl