Added RTD Docs

README.rst

@@ -3,6 +3,10 @@
 
 A `BuildNN <https://www.buildnn.com>`_ Open Source project.
 
+.. image:: https://readthedocs.org/projects/pymetager/badge/?version=latest
+  :target: https://pymetager.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation Status
+
 Installing
 ----------
 

docs/Makefile

@@ -12,7 +12,10 @@ BUILDDIR      = build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+show:
+	@python -c "import webbrowser; webbrowser.open_new_tab('file://$(PWD)/$(BUILDDIR)/html/index.html')"
+
+.PHONY: help show Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/conf.py

@@ -19,7 +19,6 @@
 
 
 # -- Project information -----------------------------------------------------
-
 project = "pymetager"
 copyright = "2021, BuildNN Team"
 author = "BuildNN Team"
@@ -39,7 +38,6 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
     'myst_parser',
-    "sphinx_rtd_theme",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -48,15 +46,14 @@
 # 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 = ["_build"]
+exclude_patterns = ["_build", "build"]
 
 
 # -- 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,
@@ -67,7 +64,7 @@
 # ---------------
 
 html_theme = "sphinx_book_theme"
-html_logo = "_static/logo.svg"
+html_logo = "_static/logo.png"
 html_favicon = "_static/favicon.svg"
 
 html_theme_options = {

docs/reference_index.rst

@@ -1,4 +1,4 @@
-.. brera-profile documentation master file, created by
+.. pymetager documentation master file, created by
    sphinx-quickstart.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.