Skip to content

Readthedocs POC#4579

Draft
andrewsanchez wants to merge 3 commits intomainfrom
rtd
Draft

Readthedocs POC#4579
andrewsanchez wants to merge 3 commits intomainfrom
rtd

Conversation

@andrewsanchez
Copy link
Contributor

@andrewsanchez andrewsanchez commented Mar 2, 2026

This is intended to demo an approach for closing #4578

Docs will temporarily be built from this branch and can be previewed here: https://anki-core.readthedocs.io/en/latest/ (anki.readthedocs.io was taken so using this just for demo purposes).

Co-authored-by: Abdo <abdo@abdnh.net>
To build the API docs used by Anki's existing Python Sphinx pipeline:

```
./ninja python:sphinx
Copy link
Contributor

Choose a reason for hiding this comment

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

hey @abdnh and @andrewsanchez
When you run this command, does this work for you?
Because, on my side, when I try to run, I get an error.

In this line: https://github.com/ankitects/anki/blob/main/build/configure/src/python.rs#L233 I must change it to:

      "$uv sync --group sphinx && $python python/sphinx/build.py" // remove this line
      "$uv sync --group docs && $python python/sphinx/build.py" // add this line

Does it make sense?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It doesn't work, because the sphinx group was removed as you noted.

sphinx = [
docs = [
"sphinx",
"sphinx_rtd_theme",
Copy link
Contributor

Choose a reason for hiding this comment

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

@andrewsanchez is there a reason to remove it?

I'm asking because when I try to run it, I get a build error, and I have to add it back to work welll

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I specified the html theme in conf.py so not sure why you're getting that error but I'll check!

Copy link
Contributor

Choose a reason for hiding this comment

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

okay, because I can't get it to run successfully locally.

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.

3 participants