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

Documentation is broken by Sphinx update #284

Closed
paleolimbot opened this issue Aug 21, 2023 · 3 comments · Fixed by #286
Closed

Documentation is broken by Sphinx update #284

paleolimbot opened this issue Aug 21, 2023 · 3 comments · Fixed by #286

Comments

@paleolimbot
Copy link
Member

It seems that with Sphine 7.2.0, breathe no longer works. Building the documetnation now yields:

https://github.com/apache/arrow-nanoarrow/actions/runs/5927664021/job/16071628489?pr=279#step:3:1199

   Running Sphinx v7.2.2
  
  Exception occurred:
    File "/usr/local/lib/python3.10/dist-packages/breathe/project.py", line 116, in __init__
      self._default_build_dir = os.path.dirname(app.doctreedir.rstrip(os.sep))
  AttributeError: 'PosixPath' object has no attribute 'rstrip'

sphinx-doc/sphinx#11605

We probably need to pin sphinx<7.2.0 or switch to quartodoc.

@lidavidm
Copy link
Member

I would be interested if you do decide to go for Quarto. One thing I was considering was leaving each language documentation in its 'native' format (so, Doxygen for C/C++, etc.) and then adding some sort of Quarto shortcode(?) or whatever to help reference language-specific things (like Sphinx's :c:func: and so on)

@paleolimbot
Copy link
Member Author

I'd definitely like to use quarto eventually (although I'm not sure I'll get there in the near future). I'm particularly excited for the ability to build things like notebooks or RMarkdown documents into directly into tutorials.

I think the quarto terminology for that kind of thing is an "extension" or "filter" and I think it has to be written in lua (but dn't quote me on that). An example: https://github.com/rstudio/py-shiny/tree/main/docs/_extensions/machow/interlinks .

@lidavidm
Copy link
Member

Ah slick, thank you!

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 a pull request may close this issue.

2 participants