Skip to main content

Astro-style references in Sphinx documents

Project description

sphinx-astrorefs

Astro-style references in Sphinx documents

Tests codecov Documentation Status image

sphinx-astrorefs is a Sphinx extension for formatting citations and references in a style similar to that used in the astrophysics literature. It is built on top of sphinxcontrib-bibtex, a Sphinx extension for including bibtex citations in Sphinx documents. By pre- and post-processing the input and output from Sphinx and sphinxcontrib-bibtex, sphinx-astrorefs allows you to obtain citations in the astro-specific style in the HTML and LaTeX rendering of your Sphinx documents.

Changelog

  • 2020/08/09: Version 0.3: Fixes a minor bug in 0.2 that caused multiple \citealt-style citations in a single line be parsed incorrectly. All reference replacements are now done one at a time, so multi-citation lines should now be handled correctly for all citation types.
  • 2020/07/22: Version 0.2: Removes printing the Sphinx builder's name and makes the bibtex label invisible in the HTML reference section without removing the element entirely and thus removing the id link, thus fixing the HTML rendering of the reference section.
  • 2020/07/01: Version 0.1.

Development notes

To release a new version, do the following

  • bumpversion release and commit the result with git commit -m "Bump version to next release" .
  • git tag `python -c "import sphinx_astrorefs; print(sphinx_astrorefs.__version__)"` && git push --tags
  • rm -rf build && rm -rf dist/* && python setup.py sdist bdist_wheel
  • twine upload dist/* for uploading to PyPI
  • bumpversion minor for setting up development version of next minor release or bumpversion major for a next major release. Then commit the result with git commit -m "Bump version to next development version" .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-astrorefs-0.4.tar.gz (8.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_astrorefs-0.4-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page