diff --git a/README.rst b/README.rst index 1808182..d0e6d66 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,10 @@ A `BuildNN `_ 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 ---------- diff --git a/docs/Makefile b/docs/Makefile index ed88099..ee8ec75 100644 --- a/docs/Makefile +++ b/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). diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..5de82d3 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/_static/logo.svg b/docs/_static/logo.svg deleted file mode 100644 index c2324bb..0000000 --- a/docs/_static/logo.svg +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html deleted file mode 100644 index 4ecb013..0000000 --- a/docs/_templates/breadcrumbs.html +++ /dev/null @@ -1,4 +0,0 @@ -{%- extends "sphinx_rtd_theme/breadcrumbs.html" %} - -{% block breadcrumbs_aside %} -{% endblock %} diff --git a/docs/conf.py b/docs/conf.py index c141e08..5bb0cc1 100644 --- a/docs/conf.py +++ b/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,7 +46,7 @@ # 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 ------------------------------------------------- @@ -56,7 +54,6 @@ # 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 = { diff --git a/docs/reference_index.rst b/docs/reference_index.rst index c449f65..bc3dbbd 100644 --- a/docs/reference_index.rst +++ b/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.