Skip to main content
Ctrl+K

Documenteer

  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
  • GitHub
  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
  • GitHub

Section Navigation

  • Rubin user guide features

First steps

  • Setting up the Documenteer configuration for Rubin user guides
  • Organizing content in a Rubin user guide

Advanced configuration

  • Configuring Python projects in documenteer.toml
  • Embedding a Redoc subsite for OpenAPI (HTTP API) documentation
  • Using the rst epilog for common links and substitutions
  • Redirecting pages when reorganizing content
  • The “Help improve” page footer
  • Extending conf.py directly

Design features

  • Diagrams as code
  • Badges
  • Tab sets
  • Embedded videos
  • Citations
    • Publishing a guide as a DOI landing page
    • Landing pages inside the site
    • Citing software from CITATION.cff
    • Software that has never been deposited
    • Citation cards
    • Inline DOI links
    • Footer citations
    • Machine-readable metadata
    • Troubleshooting citation warnings

Markdown & Jupyter Notebooks

  • Using Markdown syntax in Rubin Observatory documentation
  • Including Jupyter notebooks in documentation

Reference

  • documenteer.toml reference
  • The documenteer.conf.guide configuration preset
  • User guides
  • Citations
  • Footer citations

Footer citations#

The site footer shows the site’s citations on every page, which makes every page of the guide a landing page for the site’s DOI, not only the pages that carry a card. The citations open the footer, above the horizontal rule that separates them from the Rubin Observatory links, copyright, and funding statement that every guide shares.

The footer shows the site’s preferred citation, its self entry, and every entry that sets in_footer = true, in the order documenteer.toml declares them. On a site that publishes its own DOI, the first two are usually the same entry, so the footer shows one citation. A site that sets them on different entries shows both, and can set in_footer = false on one to show only the other. Under a “How to cite” heading, each citation shows the same three parts a card does: the label, the citation with its DOI as a https://doi.org/ hyperlink, and the note.

Scroll to the bottom of this page to see it. This site declares two citations, and its footer shows one of them: the Software entry, which is the preferred citation. The Paper entry is neither preferred nor self, so the footer leaves it out, and a card or a doi role is the only place it shows. Its in_footer = false only states that default explicitly. Setting in_footer = true instead would put the paper in the footer of every page beside the software.

Each entry also carries the same collapsed BibTeX disclosure and Copy BibTeX button a card does, so a reader can take the entry from whichever surface they are looking at.

A guide that declares no citations, or whose entries all set in_footer = false, renders no citations block at all. The script behind the copy buttons loads only on pages that have a button: every page of a site whose footer shows a citation, and otherwise only the pages that carry a card. A guide that displays no citation loads nothing.

This page was last modified on 2026-11-19.

https://documenteer.lsst.io/guides/citations/footer.html

previous

Inline DOI links

next

Machine-readable metadata

Help improve this page

Found a mistake or something missing? Edit this page on GitHub.

This page was last modified on 2026-11-19.

How to cite

Software

Sick, Jonathan. Documenteer (version 2.5.0b6.dev7+g51839207b). https://documenteer.lsst.io

BibTeX
@software{documenteer,
    author = {Sick, Jonathan},
    title = {{Documenteer}},
    version = {2.5.0b6.dev7+g51839207b},
    url = {https://documenteer.lsst.io}
}

Cite the version of Documenteer you used; this site documents the version shown.


Rubin Observatory

  • For scientists
  • News

Documentation

data.lsst.cloud

Community forum

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

The U.S. National Science Foundation (NSF) and the U.S. Department of Energy (DOE) Office of Science will support Rubin Observatory in its operations phase to carry out the Legacy Survey of Space and Time. They will also provide support for scientific research with the data. During operations, NSF funding is managed by the Association of Universities for Research in Astronomy (AURA) under a cooperative agreement with NSF, and DOE funding is managed by SLAC National Accelerator Laboratory (SLAC), under contract by DOE. Rubin Observatory is operated by NSF NOIRLab and SLAC.

NSF is an independent federal agency created by Congress in 1950 to promote the progress of science. NSF supports basic research and people to create knowledge that transforms the future.

The DOE Office of Science is the single largest supporter of basic research in the physical sciences in the United States and is working to address some of the most pressing challenges of our time.

Logos of the Vera C. Rubin Observatory, NSF, US DOE, NOIRLab, AURA, and SLAC.