Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-31 Thread Jeroen Demeyer
On 2017-05-31 12:42, Paul Leopardi wrote: On Wednesday, 31 May 2017 19:39:32 UTC+10, Jeroen Demeyer wrote: I think you need to import sage.all first, before importing anything else from sage. Thanks, in which file do you mean, every Python file that uses Sage, or some specific file?

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-31 Thread Jeroen Demeyer
On 2017-05-31 12:55, Paul Leopardi wrote: Thanks, I think I figured out what you mean. I updated conf.py to contain the following: That's not what I meant since I said that the issues you are having are unrelated to Sphinx. So by "fixing" it in Sphinx you are working around the problem, not a

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-31 Thread Paul Leopardi
On Wednesday, 31 May 2017 19:39:32 UTC+10, Jeroen Demeyer wrote: > > I think you need to import sage.all first, before importing anything > else from sage. > Thanks, I think I figured out what you mean. I updated conf.py to contain the following: ... # If extensions (or modules to document wi

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-31 Thread Paul Leopardi
On Wednesday, 31 May 2017 19:39:32 UTC+10, Jeroen Demeyer wrote: > > I think you need to import sage.all first, before importing anything > else from sage. > Thanks, in which file do you mean, every Python file that uses Sage, or some specific file? -- You received this message because yo

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-31 Thread Jeroen Demeyer
I think you need to import sage.all first, before importing anything else from sage. -- You received this message because you are subscribed to the Google Groups "sage-support" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-support+unsubscr...@go

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-30 Thread Paul Leopardi
On Tuesday, 30 May 2017 23:35:37 UTC+10, Jeroen Demeyer wrote: > > Sphinx needs to be able to import your modules to document them. There > is nothing Sphinx-specific about this, it's just usual Python imports. I > am assuming that your package works within Sage but not outside of Sage. > That

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-30 Thread Jeroen Demeyer
On 2017-05-30 15:24, Paul Leopardi wrote: Do you understand the problem yet, or do I need to explain it again in greater detail? I understand the problem, but you are focusing too much on the detail of Sphinx. The problem is unrelated to Sphinx; it has to do with your Sage/Python installation

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-30 Thread Paul Leopardi
On Tuesday, 30 May 2017 18:16:51 UTC+10, Jeroen Demeyer wrote: > > Good! Since you are sending this email, I assume that something is not > working for you. What is the problem? > Please bear with me as I retrace my steps and show you the result. 1. Following https://codeandchaos.wordpress.

Re: [sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-30 Thread Jeroen Demeyer
On 2017-05-28 14:33, Paul Leopardi wrote: Hello, I am trying to create HTML documentation for my Boolean-Cayley-graphs project ( https://github.com/penguian/Boolean-Cayley-graphs ) that uses Sage. If I try to just use Sphinx, following the instructions at https://codeandchaos.wordpress.com/2012/0

[sage-support] How to use Sphinx to create documentation for a project that uses Sage?

2017-05-28 Thread Paul Leopardi
Hello, I am trying to create HTML documentation for my Boolean-Cayley-graphs project ( https://github.com/penguian/Boolean-Cayley-graphs ) that uses Sage. If I try to just use Sphinx, following the instructions at https://codeandchaos.wordpress.com/2012/07/30/sphinx-autodoc-tutorial-for-dummies/