From 8d8f913465d98a81a8ca225730b050329a8d079b Mon Sep 17 00:00:00 2001 From: Nicholas Landry Date: Tue, 8 Nov 2022 16:12:44 -0500 Subject: [PATCH] fix title in RTD pdf (#219) Cleaned up docs --- docs/source/api/stats.rst | 11 -------- .../stats/xgi.stats.EdgeStatDispatcher.rst | 14 ---------- .../stats/xgi.stats.NodeStatDispatcher.rst | 14 ---------- .../api/stats/xgi.stats.StatDispatcher.rst | 16 ----------- docs/source/conf.py | 27 +++++-------------- 5 files changed, 6 insertions(+), 76 deletions(-) delete mode 100644 docs/source/api/stats/xgi.stats.EdgeStatDispatcher.rst delete mode 100644 docs/source/api/stats/xgi.stats.NodeStatDispatcher.rst delete mode 100644 docs/source/api/stats/xgi.stats.StatDispatcher.rst diff --git a/docs/source/api/stats.rst b/docs/source/api/stats.rst index 514faf373..39111e178 100644 --- a/docs/source/api/stats.rst +++ b/docs/source/api/stats.rst @@ -33,14 +33,3 @@ stats package ~xgi.stats.nodestat_func ~xgi.stats.edgestat_func - - -.. rubric:: Other classes (for internal use) - -.. autosummary:: - :toctree: stats - :nosignatures: - - ~xgi.stats.StatDispatcher - ~xgi.stats.EdgeStatDispatcher - ~xgi.stats.NodeStatDispatcher \ No newline at end of file diff --git a/docs/source/api/stats/xgi.stats.EdgeStatDispatcher.rst b/docs/source/api/stats/xgi.stats.EdgeStatDispatcher.rst deleted file mode 100644 index a4b0943ac..000000000 --- a/docs/source/api/stats/xgi.stats.EdgeStatDispatcher.rst +++ /dev/null @@ -1,14 +0,0 @@ -xgi.stats.EdgeStatDispatcher -============================ - -.. currentmodule:: xgi.stats - -.. autoclass:: EdgeStatDispatcher - :show-inheritance: - :members: - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: \ No newline at end of file diff --git a/docs/source/api/stats/xgi.stats.NodeStatDispatcher.rst b/docs/source/api/stats/xgi.stats.NodeStatDispatcher.rst deleted file mode 100644 index 88a4e811e..000000000 --- a/docs/source/api/stats/xgi.stats.NodeStatDispatcher.rst +++ /dev/null @@ -1,14 +0,0 @@ -xgi.stats.NodeStatDispatcher -============================ - -.. currentmodule:: xgi.stats - -.. autoclass:: NodeStatDispatcher - :show-inheritance: - :members: - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: \ No newline at end of file diff --git a/docs/source/api/stats/xgi.stats.StatDispatcher.rst b/docs/source/api/stats/xgi.stats.StatDispatcher.rst deleted file mode 100644 index d6ac82bc4..000000000 --- a/docs/source/api/stats/xgi.stats.StatDispatcher.rst +++ /dev/null @@ -1,16 +0,0 @@ -xgi.stats.StatDispatcher -======================== - -.. currentmodule:: xgi.stats - -.. autoclass:: StatDispatcher - :show-inheritance: - :members: - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~StatDispatcher.multi \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 9db45cbb2..6426af093 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,9 +20,7 @@ # -- Project information ----------------------------------------------------- project = "XGI" -copyright = "Copyright (C) 2021 XGI Developers" -authors = "Nicholas W. Landry, Leo Torres, Iacopo Iacopini, Maxime Lucas, Giovanni Petri, Alice Patania, Alice Schwarze, and Martina Contisiciani" -# The full version, including alpha/beta/rc tags +copyright = "Copyright (C) 2022 XGI Developers" release = "0.5.0" # -- General configuration --------------------------------------------------- @@ -100,7 +98,7 @@ # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = "index" +root_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -188,34 +186,21 @@ latex_documents = [ ( - master_doc, + root_doc, "xgi.tex", "XGI Documentation", - authors, + "", "manual", ), ] -man_pages = [(master_doc, "xgi", "XGI Documentation", [authors], 1)] - -texinfo_documents = [ - ( - master_doc, - "XGI", - "XGI Documentation", - "", - "XGI", - "One line description of project.", - "Miscellaneous", - ), -] +man_pages = [(root_doc, "XGI", "XGI Documentation", "", 1)] epub_title = project epub_author = "" -epub_publisher = authors +epub_publisher = "" epub_copyright = copyright - epub_exclude_files = ["search.html"]