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

Resolve ambiguous anchoring in generated RST files #441

Open
afsmythe opened this issue Dec 17, 2021 · 2 comments
Open

Resolve ambiguous anchoring in generated RST files #441

afsmythe opened this issue Dec 17, 2021 · 2 comments
Milestone

Comments

@afsmythe
Copy link

afsmythe commented Dec 17, 2021

While researching #279 it's become obvious that our RST page anchoring for extended classes could be improved. For two reasons:

  • hundreds of Sphinx warnings are generated during make html citing "WARNING: duplicate label < prefix >-< spinal_name >", e.g.
docs/built_rst/csv/elements/ballot_measure_contest.rst:72: WARNING: duplicate label multi-csv-contest-base, other instance in docs/built_rst/csv/elements/party_contest.rst
  • clicking Extends reference links in the documentation will sometimes take the user away from the original class page they are reviewing. For example, while reviewing BallotMeasureContest, if the Extends [ContestBase] link is clicked, the user is taken to the PartyContest page.

Assigning this to the 6.0 Milestone to be a part of the PR for #279.

This might be improved upon by updating the label value to include the "parent" class when it is passed to

def make_rest_header(title, label, header_char):

But this will need some further review :)

@afsmythe afsmythe added this to the Version 6.0 milestone Dec 17, 2021
@jswiesner
Copy link
Collaborator

Do we still intend to address this with 6.0? Or should we move to the backlog?

@afsmythe afsmythe modified the milestones: Version 6.0, Up for Debate Jan 14, 2022
@afsmythe
Copy link
Author

Moved to backlog as it needs some additional review.

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

No branches or pull requests

2 participants