docs: fix broken links to default_parse_stack and default_unparse_stack#521
Open
wali-reheman wants to merge 1 commit intosciunto-org:mainfrom
Open
docs: fix broken links to default_parse_stack and default_unparse_stack#521wali-reheman wants to merge 1 commit intosciunto-org:mainfrom
wali-reheman wants to merge 1 commit intosciunto-org:mainfrom
Conversation
Fixes sciunto-org#469. The docs referenced :class: links to ResolveStringReferencesMiddleware etc. in the context of 'default parse stack', but did not link to the actual functions that build the stacks (:func:~bibtexparser.middlewares.parsestack.default_parse_stack and default_unparse_stack). Updated the section text to reference the builder functions, and added parsestack to the API reference so autodoc generates links for them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #469 — documentation links to the default parse and write stacks are now resolvable.
Problem: The Customize page referenced the default middleware stacks without linking to the functions that build them. The RST used links to middleware classes rather than links to and , making those links appear as dead links on the rendered docs.
Changes:
docs/source/customize.rst: Updated the 'Default Parse and Write Stacks' section to explicitly reference and , which are the actual builder functions.
docs/source/bibtexparser.rst: Added to the API reference with so Sphinx autodoc generates links for the functions.
Test Plan
Closes #469