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

Fix documentation, remove version cap on sphinxcontrib-bibtex #523

Merged
merged 40 commits into from Feb 16, 2023

Conversation

Moritz-Alexander-Kern
Copy link
Member

This PR removes the version cap on sphinxcontrib-bibtex==1.0.0.

Newer versions of sphinxcontrib-bibtex require the path to the .bib file to be specified in the configuration file for the documentation (conf.py).

See docs here: https://elephant-docs-development.readthedocs.io/en/fix-bibtex-contrib-version-cap/modules.html

@Moritz-Alexander-Kern Moritz-Alexander-Kern added bugfix Fix for an indentified bug. documentation Indicates a need for improvements or additions to documentation build html This will trigger the upload of the docs html files as artifact in github actions and removed bugfix Fix for an indentified bug. labels Nov 4, 2022
@coveralls
Copy link
Collaborator

coveralls commented Nov 4, 2022

Coverage Status

Coverage: 87.836% (+0.3%) from 87.493% when pulling 8d476b3 on INM-6:fix/bibtex-contrib-version-cap into 0896873 on NeuralEnsemble:master.

Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

@Moritz-Alexander-Kern
Copy link
Member Author

Moritz-Alexander-Kern commented Nov 16, 2022

With version 2.2.0 the reference style can be set:

To configure your referencing style, an optional config setting bibtex_reference_style has been added. If not specified, this defaults to the label style, which will use the label to format citation references, matching the referencing style as in previous versions. The other style currently available is author_year, for author-year style referencing.

See: https://sphinxcontrib-bibtex.readthedocs.io/en/latest/changes.html

@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.12.0 milestone Nov 16, 2022
@Moritz-Alexander-Kern
Copy link
Member Author

For a sample of the new citation style, aswell as the new bibliography style, see:
https://elephant--523.org.readthedocs.build/en/523/reference/spade.html

Citation:

image

Bibliography:

image

Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

@mdenker mdenker merged commit 86e5d7b into NeuralEnsemble:master Feb 16, 2023
@Moritz-Alexander-Kern Moritz-Alexander-Kern deleted the fix/bibtex-contrib-version-cap branch July 21, 2023 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build html This will trigger the upload of the docs html files as artifact in github actions documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants