Skip to content

Commit

Permalink
Add docs/
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonChicken123 committed Dec 1, 2023
1 parent aebde1b commit 055c1d4
Show file tree
Hide file tree
Showing 19 changed files with 1,934 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
44 changes: 44 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Configuration file for the Sphinx documentation builder.

# -- Project information
import sys
import os
sys.path.insert(0, os.path.abspath('..'))

project = 'Masterchicken'
copyright = '2023, Masterchicken developers'
author = 'PythonChicken123'

release = '0.1'
version = '0.0.7'

# -- General configuration

extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'ext.headers',
'ext.boilerplate',
'ext.customversion',
'ext.edit_on_github'
]

intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
pygments_style = 'sphinx'
modindex_common_prefix = ['masterchicken']
templates_path = ['_templates']

# -- Options for HTML output

html_theme = "classic"

# -- Options for EPUB output
epub_show_urls = 'footnote'
Loading

0 comments on commit 055c1d4

Please sign in to comment.