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

Reorganizing documentation #9

Merged
merged 50 commits into from
Apr 17, 2024
Merged

Conversation

ahwagner
Copy link
Member

No description provided.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

How can I learn more about Cat-VRS and get involved?
.. see :ref:'getting_involved'
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this supposed to be a link?

Copy link
Contributor

Choose a reason for hiding this comment

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

probably supposed to link here, minus the underscore vs dash typo

Copy link
Contributor

Choose a reason for hiding this comment

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

oh it also should have an extra line break between 6 and 7 if you want it to (not) render as a commented-out line, rather than just the literal text

Copy link
Collaborator

Choose a reason for hiding this comment

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

It ended up being a problem that the 'getting_involved' was not a unique label, so it threw a fit and decided not to compile. Which, fair enough.

Copy link
Contributor

Choose a reason for hiding this comment

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

If it makes your life easier, this sphinx extension makes titles/subtitles auto-reffable (but yeah, gotta be careful about uniqueness of labels)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yea, it turns out this is one place where sphinx works very different from LaTeX, because the latter won't really care and just default to the earliest copy of the label. Which... isn't better, just that that was what I was expecting for this problem, which is why I was confounded for so long.

@DanielPuthawala DanielPuthawala marked this pull request as ready for review April 17, 2024 18:52
@DanielPuthawala DanielPuthawala self-requested a review April 17, 2024 18:52
@DanielPuthawala DanielPuthawala self-assigned this Apr 17, 2024
Copy link
Collaborator

@DanielPuthawala DanielPuthawala left a comment

Choose a reason for hiding this comment

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

Having recieved no other commends or requested edits, merging into main 1.x branch.

@DanielPuthawala DanielPuthawala merged commit 8417652 into 1.x Apr 17, 2024
3 checks passed
@DanielPuthawala DanielPuthawala deleted the reorganizing_documentation branch May 13, 2024 16:08
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 this pull request may close these issues.

5 participants