made huge changes to documentation

Author: wasimusu

docs/source/conf.py

@@ -0,0 +1,63 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../python_project'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'python_project'
+copyright = '2020, Wasim Akram Khan'
+author = 'Wasim Akram Khan'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+# First two are essential to generate the docs, others are optional.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.githubpages',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,49 @@
+python_project
+==============
+A template setup for a python project.
+
+Features
+========
+It contains the following:
+   * TravisCI for continuous integration
+   * unittest for testing the project libraries
+   * Documentation on readthedocs.org built using Sphinx, Doxygen and breathe.
+   * Packaging the library for distribution on PyPi
+
+Code snippets in rst file
+=========================
+sample.py
+
+.. code-block:: python
+   :name: sample.py
+
+    from python_project import mathlib
+
+    sum = mathlib.add(1, 1)
+    print(f"Sum : {sum}")
+
+
+APIS
+====
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+This package provides two different types of APIs.
+
+Math Lib
+========
+.. automodule:: python_project.mathlib
+   :members:
+
+String Lib
+==========
+.. automodule:: python_project.strlib
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`