You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "paleolimbot (via GitHub)" <gi...@apache.org> on 2023/08/21 14:50:27 UTC

[GitHub] [arrow-nanoarrow] paleolimbot opened a new issue, #284: Documentation is broken by Sphinx update

paleolimbot opened a new issue, #284:
URL: https://github.com/apache/arrow-nanoarrow/issues/284

   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'
   ```
   
   https://github.com/sphinx-doc/sphinx/issues/11605
   
   We probably need to pin `sphinx<7.2.0` or switch to quartodoc.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-nanoarrow] lidavidm commented on issue #284: Documentation is broken by Sphinx update

Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on issue #284:
URL: https://github.com/apache/arrow-nanoarrow/issues/284#issuecomment-1686495908

   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)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-nanoarrow] paleolimbot commented on issue #284: Documentation is broken by Sphinx update

Posted by "paleolimbot (via GitHub)" <gi...@apache.org>.
paleolimbot commented on issue #284:
URL: https://github.com/apache/arrow-nanoarrow/issues/284#issuecomment-1686563291

   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 .


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-nanoarrow] lidavidm commented on issue #284: Documentation is broken by Sphinx update

Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on issue #284:
URL: https://github.com/apache/arrow-nanoarrow/issues/284#issuecomment-1686569814

   Ah slick, thank you!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-nanoarrow] paleolimbot closed issue #284: Documentation is broken by Sphinx update

Posted by "paleolimbot (via GitHub)" <gi...@apache.org>.
paleolimbot closed issue #284: Documentation is broken by Sphinx update
URL: https://github.com/apache/arrow-nanoarrow/issues/284


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org