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

bibtex bibliography should be footbibliography #12

Closed
lilyminium opened this issue Aug 23, 2023 · 1 comment · Fixed by #13
Closed

bibtex bibliography should be footbibliography #12

lilyminium opened this issue Aug 23, 2023 · 1 comment · Fixed by #13

Comments

@lilyminium
Copy link
Member

Expected behavior

If you want a local bibliography in similarity.py, the correct directives to use are actually footbibliography and footcite. cite and bibliography are to be used for global bibliographies, like a separate references page.

Making this change allowed me to build docs as below:

Screenshot 2023-08-24 at 9 48 48 am
@lilyminium
Copy link
Member Author

lilyminium commented Aug 24, 2023

It is still weird that it goes:

  1. Function reference heading
  2. Bibliography
  3. Actual function reference

But I presume that has something to do with the layout of the module docstring:

Function reference
==================

.. All functions are included via automodule :members:.

.. rubric:: References

.. footbibliography::

@ianmkenney you may need to manually .. autosummary there if you want it in a more logical order.

Tbh a global bibliography might make more sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant