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

A few documentation tweaks #38

Merged
merged 1 commit into from
Oct 17, 2024
Merged

A few documentation tweaks #38

merged 1 commit into from
Oct 17, 2024

Conversation

bsweger
Copy link
Collaborator

@bsweger bsweger commented Oct 17, 2024

This changeset implements the Sphinx viewcode extension and also tries out an extention for adding a GitHub link to the sidebar.

Its other purpose is to try out the preview feature when submitting a PR.

@bsweger bsweger force-pushed the bsweger/add-doc-viewcode-links branch from a69d491 to e5e950d Compare October 17, 2024 17:55
This changeset implements the Sphinx viewcode extension and
also tries out an extention for adding a GitHub link to the
sidebar. It's other purpose is to try out the preview
feature when submitting a PR.
@bsweger bsweger force-pushed the bsweger/add-doc-viewcode-links branch from e5e950d to 695ff42 Compare October 17, 2024 17:59
@bsweger
Copy link
Collaborator Author

bsweger commented Oct 17, 2024

Quick view of the doc updates that result from this PR (use the above docs/readthedocs.org PR comment to preview everything)

[source] link

image

GitHub sidebar link

image

@bsweger bsweger requested a review from elray1 October 17, 2024 18:11
Copy link
Collaborator

@elray1 elray1 left a comment

Choose a reason for hiding this comment

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

Approved. I wonder if there's anything we can do to get rid of the ads?
image

@bsweger
Copy link
Collaborator Author

bsweger commented Oct 17, 2024

Approved. I wonder if there's anything we can do to get rid of the ads?

We could turn off paid ads and just display community ads. However, the ads ("ethical" ads w/o tracking) are a key component of readthedocs' business model (in fact, they also appear on hubverse.io).

I don't love how the ads keep moving from the left sidebar to the right sidebar, though--would prefer they stay in one place, and we can probably tweak that.

@bsweger bsweger merged commit 5847385 into main Oct 17, 2024
2 checks passed
@bsweger bsweger deleted the bsweger/add-doc-viewcode-links branch October 17, 2024 20:14
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