diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 111a2ae2..b0f0c142 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,5 +1,5 @@ ============= -Release Notes +Release notes ============= .. current developments diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index ff9c3561..e8199ca5 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -8,7 +8,7 @@ Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, +identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. diff --git a/README.rst b/README.rst index f3eb5f0c..dac60867 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ :target: https://diffpy.github.io/diffpy.pdfgui :height: 100px -|PyPi| |Forge| |PythonVersion| |PR| +|PyPI| |Forge| |PythonVersion| |PR| |CI| |Codecov| |Black| |Tracking| @@ -26,7 +26,7 @@ .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff -.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.pdfgui +.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.pdfgui :target: https://pypi.org/project/diffpy.pdfgui/ .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.pdfgui @@ -35,7 +35,7 @@ .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue :target: https://github.com/diffpy/diffpy.pdfgui/issues -Graphical user interface program for structure refinements to atomic +Graphical user interface program for structure refinements to the atomic pair distribution function. For users who do not have the expertise or necessity for command @@ -167,4 +167,9 @@ Before contributing, please read our `Code of Conduct `_ or email Prof. Simon Billinge at sb2896@columbia.edu. +For more information on diffpy.pdfgui please visit the project `web-page `_ or email Simon Billinge at sb2896@columbia.edu. + +Acknowledgements +---------------- + +``diffpy.pdfgui`` is built and maintained with `scikit-package `_. diff --git a/doc/source/conf.py b/doc/source/conf.py index e4d1788a..47bd02ca 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,6 +13,12 @@ # All configuration values have a default; values that are commented out # serve to show the default. +# Attempt to import the version dynamically from GitHub tag. +try: + fullversion = version("diffpy.pdfgui") +except Exception: + fullversion = "No version found. The correct version will appear in the released version." # noqa: E501 + import sys import time from importlib.metadata import version @@ -42,6 +48,7 @@ "sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.intersphinx", + "sphinx_copybutton", "sphinx_rtd_theme", "m2r", ] @@ -64,6 +71,11 @@ project = "diffpy.pdfgui" copyright = "%Y, The Trustees of Columbia University in the City of New York" +# For sphinx_copybutton extension. +# Do not copy "$" for shell commands in code-blocks. +copybutton_prompt_text = r"^\$ " +copybutton_prompt_is_regexp = True + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -123,6 +135,14 @@ # html_theme = "sphinx_rtd_theme" +html_context = { + "display_github": True, + "github_user": "diffpy", + "github_repo": "diffpy.pdfgui", + "github_version": "main", + "conf_py_path": "/doc/source/", +} + # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. @@ -158,7 +178,7 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -html_extra_path = ["../manual"] +html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -221,7 +241,13 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ("index", "diffpy.pdfgui.tex", "diffpy.pdfgui Documentation", ab_authors, "manual"), + ( + "index", + "diffpy.pdfgui.tex", + "diffpy.pdfgui Documentation", + ab_authors, + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -249,7 +275,15 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [("index", "diffpy.pdfgui", "diffpy.pdfgui Documentation", ab_authors, 1)] +man_pages = [ + ( + "index", + "diffpy.pdfgui", + "diffpy.pdfgui Documentation", + ab_authors, + 1, + ) +] # If true, show URL addresses after external links. # man_show_urls = False diff --git a/doc/source/index.rst b/doc/source/index.rst index 081bd2be..ba6a58f3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,7 +4,7 @@ .. |title| replace:: diffpy.pdfgui documentation -diffpy.pdfgui - GUI for PDF simulation and structure refinement. +``diffpy.pdfgui`` - Graphical user interface program for structure refinements to the atomic pair distribution function. | Software version |release| | Last updated |today| diff --git a/news/doc.rst b/news/doc.rst new file mode 100644 index 00000000..b0ec659f --- /dev/null +++ b/news/doc.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/). + +**Security:** + +*