Merge pull request #14 from sandialabs/dev

Dev

Author: mrbuche

.github/workflows/pages.yml

@@ -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 <https://anaconda.or
 
     conda install --channel mrbuche statmechcrack
     
-Alternatively, a branch can be directly installed using
-
-::
-
-    pip install git+https://github.com/sandialabs/statmechcrack.git@<branch-name>
-
-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

README.rst

@@ -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']

docs/source/conf.py

@@ -1,5 +1,5 @@
-statmechcrack.core module
-=========================
+statmechcrack.core
+==================
 
 .. automodule:: statmechcrack.core
    :members:
@@ -12,7 +12,5 @@ statmechcrack.core module
 
    <hr>
 
-**References**
-
 .. bibliography::
    :filter: docname in docnames

docs/source/statmechcrack.core.rst

@@ -1,5 +1,5 @@
-statmechcrack.isometric module
-==============================
+statmechcrack.isometric
+=======================
 
 .. automodule:: statmechcrack.isometric
    :members:

docs/source/statmechcrack.isometric.rst

@@ -1,5 +1,5 @@
-statmechcrack.isotensional module
-=================================
+statmechcrack.isotensional
+==========================
 
 .. automodule:: statmechcrack.isotensional
    :members:

docs/source/statmechcrack.isotensional.rst

@@ -1,5 +1,5 @@
-statmechcrack.mechanical module
-===============================
+statmechcrack.mechanical
+========================
 
 .. automodule:: statmechcrack.mechanical
    :members:
@@ -12,7 +12,5 @@ statmechcrack.mechanical module
 
    <hr>
 
-**References**
-
 .. bibliography::
    :filter: docname in docnames

docs/source/statmechcrack.mechanical.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
 
    <hr>
 
-**References**
-
 .. bibliography::
    :filter: docname in docnames