diff --git a/.gitignore b/.gitignore index 441ce07..d63bf19 100644 --- a/.gitignore +++ b/.gitignore @@ -149,3 +149,16 @@ codeql **/**/.idea **/**/.qodana **/**/build +.~lock.*.ods# +.pytest_cache/ +.python-version + +build +env +tmp +venv +*.swp +**/dist/ +**/*.egg-info/ +*/target/ +__pycache__ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -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) diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..0e42098 --- /dev/null +++ b/docs/source/conf.py @@ -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" diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..e30cd6e --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,9 @@ +Parrot Extension +================ +Extension for Parrot Libre AI IDE. + +This is under development. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..464d509 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +sphinx +sphinx-rtd-theme +sphinx-autodoc-typehints +sphinxcontrib-markdown +sphinx-autobuild +sphinx-intl