Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a CITATION.md and a citing page to the docs #1731

Merged
merged 2 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
If you use AMReX-Astro Microphysics, please cite the Zenodo DOI.
The latest version is always here: https://doi.org/10.5281/zenodo.2620544
1 change: 1 addition & 0 deletions Docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ clean:

html:
./rp.py > source/runtime_parameters.rst
curl -L -H 'Accept: application/x-bibtex' https://zenodo.org/api/records/2620544 > source/zenodo.bibtex.txt
doxygen Doxyfile
breathe-apidoc --o source doxy_files/xml
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Expand Down
9 changes: 9 additions & 0 deletions Docs/source/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Citing Microphysics
===================

.. mdinclude:: ../../CITATION.md

The bibtex for the latest version is included below (updated automatically):

.. literalinclude:: ./zenodo.bibtex.txt
:language: bibtex
34 changes: 16 additions & 18 deletions Docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Microphysics documentation build configuration file, created by
# sphinx-quickstart on Tue Oct 23 11:59:54 2018.
Expand All @@ -23,16 +22,14 @@
import subprocess
import sys

import breathe

sys.path.insert(0, os.path.abspath('.'))

def get_version():
prog = shlex.split("git describe --tags --abbrev=0")
p0 = subprocess.Popen(prog, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout0, stderr0 = p0.communicate()
rc = p0.returncode
stdout0, _ = p0.communicate()
stdout = stdout0.decode('utf-8')
return stdout

Expand All @@ -47,21 +44,22 @@ def get_version():
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx_math_dollar',
'sphinx.ext.viewcode',
'sphinxcontrib.bibtex',
'nbsphinx',
'numpydoc',
'IPython.sphinxext.ipython_console_highlighting',
'sphinx.ext.githubpages',
'sphinx_copybutton',
'sphinx-prompt',
'sphinx_rtd_theme',
'breathe']
'sphinx.ext.mathjax',
'sphinx_math_dollar',
'sphinx.ext.viewcode',
'sphinxcontrib.bibtex',
'nbsphinx',
'numpydoc',
'IPython.sphinxext.ipython_console_highlighting',
'sphinx.ext.githubpages',
'sphinx_copybutton',
'sphinx-prompt',
'sphinx_mdinclude',
'sphinx_rtd_theme',
'breathe']

breathe_projects = {
"microphysics":"../doxy_files/xml",
"microphysics": "../doxy_files/xml",
}

breathe_default_project = "microphysics"
Expand Down Expand Up @@ -128,7 +126,7 @@ def get_version():

mathjax3_config["tex"]["macros"] = {}

with open('mathsymbols.tex', 'r') as f:
with open('mathsymbols.tex') as f:
for line in f:
macros = re.findall(r'\\newcommand{\\(.*?)}(\[(\d)\])?{(.+)}', line)
for macro in macros:
Expand Down
1 change: 1 addition & 0 deletions Docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ of state routines.
:caption: References
:hidden:

citing
zreferences

.. toctree::
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ numpy>=1.13.3
sphinx-prompt
sphinx-math-dollar
sphinx-copybutton
sphinx-mdinclude
Loading