Using docbuild on an external package

asked 2023-08-29 03:42:48 +0200

jaebond gravatar image

updated 2023-08-29 04:13:50 +0200

I am attempting to use docbuild to build Sage-style documentation for a package that is external to Sage. I haven't been able to find information on how to set up and run the docbuild pipeline and am running into several errors. Is there any information available on how to configure docbuild for external packages?

I'm running the command as sage --docbuild file=/path/to/file html. I was running into a missing theme, but downloading this directory: (which was missing from my mamba installation of Sage) and running the command from with the .../site-packages/sage directory seems have to solved that.

A few errors I'm still running into:

  • SAGE_DOC_SRC seems to be set to the wrong location. I think this is because SAGE_ROOT is being set to /home/user/mamba/envs/sage instead of .../site-packages/sage, but I haven't been able to resolve this.
  • I'm running into an error in sphinx.ext.doctest where doctest.DocTestParser() is raising AttributeError: module 'doctest' has no attribute 'DocTestParser'
edit retag flag offensive close merge delete


Could be a source of inspiration?

eric_g gravatar imageeric_g ( 2023-08-29 23:05:45 +0200 )edit

See I don't think this is supported, although it would be nice if it were.

John Palmieri gravatar imageJohn Palmieri ( 2023-08-31 01:52:00 +0200 )edit