From 02210c20793301a3a8cb846ea30fd70e74c7d880 Mon Sep 17 00:00:00 2001 From: mrbuche Date: Mon, 23 Jan 2023 12:00:49 -0700 Subject: [PATCH] docs foot/bib fix --- README.rst | 18 ++++------ docs/source/conf.py | 3 ++ docs/source/statmechcrack.core.rst | 6 ++-- docs/source/statmechcrack.isometric.rst | 4 +-- docs/source/statmechcrack.isotensional.rst | 4 +-- docs/source/statmechcrack.mechanical.rst | 6 ++-- docs/source/statmechcrack.monte_carlo.rst | 6 ++-- docs/source/statmechcrack.rst | 33 ------------------- docs/source/statmechcrack.tests.__main__.rst | 8 ----- docs/source/statmechcrack.tests.rst | 26 --------------- .../statmechcrack.tests.test_boundary.rst | 4 +-- .../statmechcrack.tests.test_examples.rst | 4 +-- .../statmechcrack.tests.test_interface.rst | 4 +-- docs/source/statmechcrack.tests.test_many.rst | 4 +-- docs/source/statmechcrack.tests.test_one.rst | 4 +-- .../source/statmechcrack.tests.test_style.rst | 4 +-- docs/source/statmechcrack.tests.test_zero.rst | 4 +-- docs/source/statmechcrack.utility.rst | 4 +-- 18 files changed, 35 insertions(+), 111 deletions(-) delete mode 100644 docs/source/statmechcrack.rst delete mode 100644 docs/source/statmechcrack.tests.__main__.rst delete mode 100644 docs/source/statmechcrack.tests.rst diff --git a/README.rst b/README.rst index 7ecbf51..12d994d 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ statMechCrack ############# -|build| |docs| |codefactor| +|stable| |latest| |codefactor| Statistical mechanical models for crack growth. @@ -24,13 +24,7 @@ or using ``conda`` via the ``mrbuche`` channel on `Anaconda - -or after cloning a branch and executing ``python setup.py install``. Any installation is tested by executing ``python -m statmechcrack.tests``. +Any installation is tested by executing ``python -m statmechcrack.tests``. ******** Citation @@ -51,11 +45,11 @@ Copyright 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS .. Badges ======================================================================== -.. |build| image:: https://img.shields.io/github/actions/workflow/status/sandialabs/statmechcrack/main.yml?branch=main&label=GitHub&logo=github - :target: https://github.com/sandialabs/statmechcrack +.. |stable| image:: https://img.shields.io/badge/Docs-stable-8CA1AF?logo=readthedocs + :target: https://statmechcrack.readthedocs.io/en/stable -.. |docs| image:: https://img.shields.io/readthedocs/statmechcrack?logo=readthedocs&label=Read%20the%20Docs - :target: https://statmechcrack.readthedocs.io/en/latest/ +.. |latest| image:: https://img.shields.io/badge/Docs-latest-8CA1AF?logo=readthedocs + :target: https://statmechcrack.readthedocs.io/en/latest .. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sandialabs/statmechcrack?label=Codefactor&logo=codefactor :target: https://www.codefactor.io/repository/github/sandialabs/statmechcrack diff --git a/docs/source/conf.py b/docs/source/conf.py index 72ba910..533edbc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,7 +26,9 @@ def get_version(): add_module_names = False bibtex_bibfiles = ['main.bib'] +bibtex_bibliography_header = ".. rubric:: References" bibtex_default_style = 'plain' +bibtex_footbibliography_header = bibtex_bibliography_header extensions = [ 'matplotlib.sphinxext.plot_directive', 'nbsphinx', @@ -53,4 +55,5 @@ def get_version(): plot_include_source = True plot_rcparams = {'font.size': 10} plot_formats = [('png', 300)] +suppress_warnings = ["bibtex.duplicate_label"] templates_path = ['_templates'] diff --git a/docs/source/statmechcrack.core.rst b/docs/source/statmechcrack.core.rst index a4de728..8a1d032 100644 --- a/docs/source/statmechcrack.core.rst +++ b/docs/source/statmechcrack.core.rst @@ -1,5 +1,5 @@ -statmechcrack.core module -========================= +statmechcrack.core +================== .. automodule:: statmechcrack.core :members: @@ -12,7 +12,5 @@ statmechcrack.core module
-**References** - .. bibliography:: :filter: docname in docnames diff --git a/docs/source/statmechcrack.isometric.rst b/docs/source/statmechcrack.isometric.rst index 4da1c1a..47c7844 100644 --- a/docs/source/statmechcrack.isometric.rst +++ b/docs/source/statmechcrack.isometric.rst @@ -1,5 +1,5 @@ -statmechcrack.isometric module -============================== +statmechcrack.isometric +======================= .. automodule:: statmechcrack.isometric :members: diff --git a/docs/source/statmechcrack.isotensional.rst b/docs/source/statmechcrack.isotensional.rst index b817c2a..56c2bd7 100644 --- a/docs/source/statmechcrack.isotensional.rst +++ b/docs/source/statmechcrack.isotensional.rst @@ -1,5 +1,5 @@ -statmechcrack.isotensional module -================================= +statmechcrack.isotensional +========================== .. automodule:: statmechcrack.isotensional :members: diff --git a/docs/source/statmechcrack.mechanical.rst b/docs/source/statmechcrack.mechanical.rst index a765ae7..229f08d 100644 --- a/docs/source/statmechcrack.mechanical.rst +++ b/docs/source/statmechcrack.mechanical.rst @@ -1,5 +1,5 @@ -statmechcrack.mechanical module -=============================== +statmechcrack.mechanical +======================== .. automodule:: statmechcrack.mechanical :members: @@ -12,7 +12,5 @@ statmechcrack.mechanical module
-**References** - .. bibliography:: :filter: docname in docnames diff --git a/docs/source/statmechcrack.monte_carlo.rst b/docs/source/statmechcrack.monte_carlo.rst index 36d8511..2a08ce2 100644 --- a/docs/source/statmechcrack.monte_carlo.rst +++ b/docs/source/statmechcrack.monte_carlo.rst @@ -1,5 +1,5 @@ -statmechcrack.monte\_carlo module -================================= +statmechcrack.monte\_carlo +========================== .. automodule:: statmechcrack.monte_carlo :members: @@ -12,7 +12,5 @@ statmechcrack.monte\_carlo module
-**References** - .. bibliography:: :filter: docname in docnames diff --git a/docs/source/statmechcrack.rst b/docs/source/statmechcrack.rst deleted file mode 100644 index 0f772fd..0000000 --- a/docs/source/statmechcrack.rst +++ /dev/null @@ -1,33 +0,0 @@ -statmechcrack package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - statmechcrack.q2d - statmechcrack.tests - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - statmechcrack.core - statmechcrack.isometric - statmechcrack.isotensional - statmechcrack.mechanical - statmechcrack.monte_carlo - statmechcrack.utility - -Module contents ---------------- - -.. automodule:: statmechcrack - :members: - :undoc-members: - :show-inheritance: - :private-members: diff --git a/docs/source/statmechcrack.tests.__main__.rst b/docs/source/statmechcrack.tests.__main__.rst deleted file mode 100644 index cda1588..0000000 --- a/docs/source/statmechcrack.tests.__main__.rst +++ /dev/null @@ -1,8 +0,0 @@ -statmechcrack.tests.\_\_main\_\_ module -======================================= - -.. automodule:: statmechcrack.tests.__main__ - :members: - :undoc-members: - :show-inheritance: - :private-members: diff --git a/docs/source/statmechcrack.tests.rst b/docs/source/statmechcrack.tests.rst deleted file mode 100644 index 55006b0..0000000 --- a/docs/source/statmechcrack.tests.rst +++ /dev/null @@ -1,26 +0,0 @@ -statmechcrack.tests package -=========================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - statmechcrack.tests.__main__ - statmechcrack.tests.test_boundary - statmechcrack.tests.test_examples - statmechcrack.tests.test_interface - statmechcrack.tests.test_many - statmechcrack.tests.test_one - statmechcrack.tests.test_style - statmechcrack.tests.test_zero - -Module contents ---------------- - -.. automodule:: statmechcrack.tests - :members: - :undoc-members: - :show-inheritance: - :private-members: diff --git a/docs/source/statmechcrack.tests.test_boundary.rst b/docs/source/statmechcrack.tests.test_boundary.rst index 76e6e69..f9d2668 100644 --- a/docs/source/statmechcrack.tests.test_boundary.rst +++ b/docs/source/statmechcrack.tests.test_boundary.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_boundary module -========================================= +statmechcrack.tests.test\_boundary +================================== .. automodule:: statmechcrack.tests.test_boundary :members: diff --git a/docs/source/statmechcrack.tests.test_examples.rst b/docs/source/statmechcrack.tests.test_examples.rst index ccc4772..5487f2d 100644 --- a/docs/source/statmechcrack.tests.test_examples.rst +++ b/docs/source/statmechcrack.tests.test_examples.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_examples module -========================================= +statmechcrack.tests.test\_examples +================================== .. automodule:: statmechcrack.tests.test_examples :members: diff --git a/docs/source/statmechcrack.tests.test_interface.rst b/docs/source/statmechcrack.tests.test_interface.rst index c71206c..844a554 100644 --- a/docs/source/statmechcrack.tests.test_interface.rst +++ b/docs/source/statmechcrack.tests.test_interface.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_interface module -========================================== +statmechcrack.tests.test\_interface +=================================== .. automodule:: statmechcrack.tests.test_interface :members: diff --git a/docs/source/statmechcrack.tests.test_many.rst b/docs/source/statmechcrack.tests.test_many.rst index d2043b8..0787f67 100644 --- a/docs/source/statmechcrack.tests.test_many.rst +++ b/docs/source/statmechcrack.tests.test_many.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_many module -===================================== +statmechcrack.tests.test\_many +============================== .. automodule:: statmechcrack.tests.test_many :members: diff --git a/docs/source/statmechcrack.tests.test_one.rst b/docs/source/statmechcrack.tests.test_one.rst index d65d22b..d9d862c 100644 --- a/docs/source/statmechcrack.tests.test_one.rst +++ b/docs/source/statmechcrack.tests.test_one.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_one module -==================================== +statmechcrack.tests.test\_one +============================= .. automodule:: statmechcrack.tests.test_one :members: diff --git a/docs/source/statmechcrack.tests.test_style.rst b/docs/source/statmechcrack.tests.test_style.rst index 75e37dd..836705d 100644 --- a/docs/source/statmechcrack.tests.test_style.rst +++ b/docs/source/statmechcrack.tests.test_style.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_style module -====================================== +statmechcrack.tests.test\_style +=============================== .. automodule:: statmechcrack.tests.test_style :members: diff --git a/docs/source/statmechcrack.tests.test_zero.rst b/docs/source/statmechcrack.tests.test_zero.rst index f57776e..7260bb4 100644 --- a/docs/source/statmechcrack.tests.test_zero.rst +++ b/docs/source/statmechcrack.tests.test_zero.rst @@ -1,5 +1,5 @@ -statmechcrack.tests.test\_zero module -===================================== +statmechcrack.tests.test\_zero +============================== .. automodule:: statmechcrack.tests.test_zero :members: diff --git a/docs/source/statmechcrack.utility.rst b/docs/source/statmechcrack.utility.rst index d02f625..7d5b394 100644 --- a/docs/source/statmechcrack.utility.rst +++ b/docs/source/statmechcrack.utility.rst @@ -1,5 +1,5 @@ -statmechcrack.utility module -============================ +statmechcrack.utility +===================== .. automodule:: statmechcrack.utility :members: