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

Fixing bibliography in documentation build #1596

Merged
merged 3 commits into from
May 31, 2021

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented May 30, 2021

This PR makes the bibliography appear in the documentation again.

Description

In the environment file, sets sphinxcontrib-bibtex to version 1.0

EDIT: Instead of changing the environment file, this PR removes the utf8 encoding from docs/zreferences.rst.

Motivation and context

After the merge of #1567, the bibliography on the documentation went away (see https://tardis-sn.github.io/tardis/zreferences.html).

How has this been tested?

  • Testing pipeline.
  • Other.
    Documentation built locally and on github.

Examples

The issue is fixed when I built the documentation on my fork with my changes: https://smithis7.github.io/tardis/branch/bibliography_issue/zreferences.html.

To make sure the issue appeared on my fork without the changes, I also built the documentation on my fork without my changes: https://smithis7.github.io/tardis/branch/control_doc/zreferences.html.

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@codecov
Copy link

codecov bot commented May 30, 2021

Codecov Report

Merging #1596 (044908e) into master (a069d1e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1596   +/-   ##
=======================================
  Coverage   67.20%   67.20%           
=======================================
  Files          73       73           
  Lines        6147     6147           
=======================================
  Hits         4131     4131           
  Misses       2016     2016           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a069d1e...044908e. Read the comment docs.

@epassaro
Copy link
Member

I think removing the :encoding: option from zrefernces.rst will make it work again @smithis7.

@isaacgsmith
Copy link
Member Author

I think removing the :encoding: option from zrefernces.rst will make it work again @smithis7.

Ok, I did that and it did work.

@epassaro epassaro merged commit a8a719b into tardis-sn:master May 31, 2021
@isaacgsmith isaacgsmith deleted the bibliography_issue branch June 1, 2021 14:53
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* attempting to fix bibliography

* [build docs]

* second attempt [build docs]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants