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.

Sign up for GitHub

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

Jump to bottom

docs: get rid of breathe #1935

Closed
lidavidm opened this issue Jun 25, 2024 · 2 comments · Fixed by #2196
Closed

docs: get rid of breathe #1935

lidavidm opened this issue Jun 25, 2024 · 2 comments · Fixed by #2196
Assignees
@lidavidm
Labels
Type: enhancement New feature or request
Milestone
ADBC Libraries 15

Comments

@lidavidm
Copy link
Member

What feature or improvement would you like to see?

It constantly causes issues with Sphinx, the rendering isn't great, and it's seemingly not actively developed anymore. We should do what we did with the fake javadoc-intersphinx bridge instead.
@lidavidm lidavidm added the Type: enhancement New feature or request label Jun 25, 2024
@lidavidm lidavidm added this to the ADBC Libraries 13 milestone Jun 25, 2024
@lidavidm lidavidm self-assigned this Jun 25, 2024
@lidavidm
Copy link
Member Author

More incentive: it's not quite maintained, unfortunately. For the time being moving off of breathe would let us keep up with Sphinx updates sphinx-doc/sphinx#12629 (comment)

@lidavidm
Copy link
Member Author

lidavidm commented Sep 3, 2024

It looks like the HTML output is not super easily parseable, but I think we can do this:

  • parse xml/index.xml to get all names; each name appears to have a unique hex ID
  • parse html/search to get a reverse mapping of hex IDs to URLs (since it is not obvious how to generate the URL given only the information in the XML)

Then we can generate a Sphinx inventory

@lidavidm lidavidm mentioned this issue Sep 6, 2024
Merged
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Sep 27, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
230d401 
Fixes apache#1935.
@lidavidm lidavidm mentioned this issue Sep 27, 2024
Merged
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Sep 27, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
491c753 
Fixes apache#1935.
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Sep 27, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
31ab741 
Fixes apache#1935.
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Oct 7, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
8df85d2 
Fixes apache#1935.
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Oct 7, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
7c7dfa2 
Fixes apache#1935.
lidavidm added a commit to lidavidm/arrow-adbc that referenced this issue Oct 7, 2024
@lidavidm
docs: link to Doxygen output instead of using breathe
21049ea 
Fixes apache#1935.
lidavidm added a commit that referenced this issue Oct 8, 2024
@lidavidm @kou
docs: link to Doxygen output instead of using breathe (#2196)
72291a9 
- Upgrade to Sphinx 8
- Drop `breathe` (now unmaintained)
- Update the intersphinx hack to support cross-linking to
Doxygen-generated docs
- Generate the Doxygen docs as a subdirectory of the main docs

Fixes #1935.

---------

Co-authored-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lidavidm lidavidm

Labels
Type: enhancement New feature or request
Projects
None yet
Milestone
ADBC Libraries 15
Development

Successfully merging a pull request may close this issue.

docs: link to Doxygen output instead of using breathe lidavidm/arrow-adbc
1 participant
@lidavidm