Skip to content

Conversation

@cvanelteren
Copy link
Collaborator

Updates the docs to ensure that the links are visualized. It further also improves styling to use UltraPlot in text and ultraplot in code.

Addresses #90

@cvanelteren cvanelteren marked this pull request as draft February 21, 2025 09:51
@cvanelteren
Copy link
Collaborator Author

cvanelteren commented Feb 21, 2025

for me later: I used:

(`~matplotlib(?:\.[A-z]+)*)(\.[A-Z][a-z_]+`)

@cvanelteren
Copy link
Collaborator Author

Note to self: autoapi and autodoc don't play nice together.

@cvanelteren
Copy link
Collaborator Author

Ok I wasted a couple of hours on this and it turned out to be autoapi -- which I added some time ago.

@cvanelteren cvanelteren marked this pull request as ready for review February 21, 2025 13:58
@cvanelteren
Copy link
Collaborator Author

Note the added function in conf.py was necessary to get it to expand the docstrings.

@cvanelteren cvanelteren marked this pull request as draft February 21, 2025 14:21
@cvanelteren
Copy link
Collaborator Author

I think I will fix this by going back to main and only adding the conf.py. Docs are building fine locally, but not on the action. Furthermore, the submitted changes are not necessary I think. Other than the first one.

Copy link
Collaborator

@beckermr beckermr left a comment

Choose a reason for hiding this comment

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

Things like :class: etc. are still not applied everywhere. That's OK, but I thought I would mention it.

I flagged a few changes we should rollback.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to be updating this file in our PRs. Let's open an issue to backport the updates for the versions not in here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done, and thanks ;-).

@cvanelteren cvanelteren mentioned this pull request Feb 21, 2025
cvanelteren and others added 10 commits February 21, 2025 16:46
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
@cvanelteren
Copy link
Collaborator Author

Could be that we have to pin sphinx to 8.1.2. Seeing some errors pop-up locally.

Co-authored-by: Matthew R. Becker <beckermr@users.noreply.github.com>
Copy link
Collaborator

@beckermr beckermr left a comment

Choose a reason for hiding this comment

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

Changes look good. When you are happy with the build, merge away!

@cvanelteren cvanelteren marked this pull request as ready for review February 21, 2025 16:21
@cvanelteren cvanelteren enabled auto-merge (squash) February 21, 2025 16:22
@cvanelteren cvanelteren merged commit eea3824 into Ultraplot:main Feb 21, 2025
13 checks passed
@cvanelteren cvanelteren deleted the doc-link-fix branch February 21, 2025 16:28
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.

2 participants