[FEATURE] Enable Sphinx Documentation Prototype

docs/conf.py

@@ -11,18 +11,19 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-# import sys
-# import os
+import sys
+import os
+import argparse
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../pythonrepo'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
+needs_sphinx = '4.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -35,7 +36,7 @@
 source_suffix = '.md'
 
 # The encoding of source files.
-# source_encoding = 'utf-8-sig'
+source_encoding = 'utf-8'
 
 # The master toctree document.
 master_doc = 'index'
@@ -49,9 +50,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = 'v1.1'
+version = 'v2.0'
 # The full version, including alpha/beta/rc tags.
-release = 'v1.1.4'
+release = 'v2.0.0-alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -62,20 +63,21 @@
 # today = ''
 # Else, today_fmt is used as the format for a strftime call.
 # today_fmt = '%B %d, %Y'
+today_fmt = '%Y.%B.%d'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', 'tests']
+exclude_patterns = ['_build', '.github/', '.circleci/', 'dist', 'tests']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
+add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-# add_module_names = True
+add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.

docs/index.md

@@ -1,20 +1,14 @@
-.. python_repo documentation master file, created by
-   sphinx-quickstart on Mon Apr 16 21:22:43 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+# Welcome to Python Repo' documentation!
+---
+### Contents:
 
-Welcome to Python Repo' documentation!
-================================================
+	toctree::
+	:maxdepth: 2
 
-Contents:
 
-.. toctree::
-   :maxdepth: 2
 
-
-
-Indices and tables
-==================
+### Indices and tables
+---
 
 * :ref:`genindex`
 * :ref:`modindex`