Hi Paul, let me mention that there is a "sage sample project": https://github.com/sagemath/sage_sample#documentation which you may use. although in that project, it is implicit that you have .py files (instead of .sage files). some indications are given in this FAQ: http://doc.sagemath.org/html/en/faq/faq-contribute.html#i-wrote-some-sage-code-and-i-want-it-to-be-integrated-into-sage-however-after-renaming-my-file-a-sage-to-a-py-i-got-syntax-errors-do-i-have-to-rewrite-all-my-code-in-python-instead-of-sage
El domingo, 28 de mayo de 2017, 14:33:46 (UTC+2), Paul Leopardi escribió: > > 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/ > > it is no clear to me how to tell Sphinx where to find everything in Sage > that it might need to import. > > The Sage documentation itself says how to generate the Sage manuals ( > http://doc.sagemath.org/html/en/developer/sage_manuals.html ). > I can't find anything that says how to generate documentation for code > that uses Sage without incorporating that code into Sage proper. > > I need step by step instructions, with examples. Do these exist somewhere? > Have I overlooked something? Or is it just assumed that I should fork Sage > itself and incorporate my code there, just so that I can generate > documentation? > All the best, Paul > > -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/sage-support. For more options, visit https://groups.google.com/d/optout.
