Re: [sphinx-dev] Include HTML in generated Sphinx docs
are you talking about relative links, since root http server? please could you explain if you want use include some java script to do that? it is this you want? best regards. 2012/10/22 James Brady ja...@trigger.io Hi all, we're documenting a project which includes some Java APIs, and we'd really like to include the pre-generated Javadocs with the Sphinx docs. Of course, we could put the HTML in the static directory, but I'm not sure how to link to it without using absolute links. Is there some way to include, and link to, HTML in Sphinx output? Thanks! -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/QHOAP99XIO0J. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: autosummary no longer links methods in the class to documentation
if i understand your issue, have you see this entire documentation more detailed information about *sphinx-autogen* – generate autodoc stub pageshttp://sphinx.pocoo.org/latest/ext/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages The *sphinx-autogen* script can be used to conveniently generate stub documentation pages for items included in autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary listings. For example, the command $ sphinx-autogen -o generated *.rst please what is your operation system, and python version? are you verified variables PATH and PYTHONPATH to assure that they point for your new sphinx versions? best regards http://sphinx.pocoo.org/latest/ext/autosummary.html#module-sphinx.ext.autosummary 2012/10/25 Lisa Zorn lisa.z...@sfcta.org Anyone? This is so frustrating because I now build two sets of sphinx documentation with the same code (sphinx 1.1.3) and similar conf.py files and one exhibits the problem and the other does not. I have made sure the problem set has no errors during documentation generation, I'm just not sure why one has the xref but the other one does not. -Lisa On Friday, August 17, 2012 12:29:16 PM UTC-7, Lisa Zorn wrote: Hello -- I was using sphinx 1.0.7 and autosummary to generate html for my python module. I recently upgraded to sphinx 1.1.3 and now for the class pages, the methods no longer link to their documentation. old: http://dta.googlecode.**com/git-history/** 4f593ec661fe5309ad0af5f027aefb**02519fd726/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html new: http://dta.googlecode.**com/git-history/** 55ccd338da95c0ff6c41ddee187565**5d2023039c/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html I have looked around for options and so forth that could have caused this but found nothing. My conf.py and index.rst are in here: http://code.google.com/**p/dta/source/browse/?name=dev#**git%2Fdochttp://code.google.com/p/dta/source/browse/?name=dev#git%2Fdoc Thank you for any assistance; I really need those links back because the pages are a hassle to use now. -Lisa -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/sdxnsdrr1PgJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: autosummary no longer links methods in the class to documentation
try force this in your conf.py to your 1.1.3 and see logs and results. # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' 2012/10/29 gilberto dos santos alves gsa...@gmail.com if i understand your issue, have you see this entire documentation more detailed information about *sphinx-autogen* – generate autodoc stub pageshttp://sphinx.pocoo.org/latest/ext/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages The *sphinx-autogen* script can be used to conveniently generate stub documentation pages for items included in autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary listings. For example, the command $ sphinx-autogen -o generated *.rst please what is your operation system, and python version? are you verified variables PATH and PYTHONPATH to assure that they point for your new sphinx versions? best regards http://sphinx.pocoo.org/latest/ext/autosummary.html#module-sphinx.ext.autosummary 2012/10/25 Lisa Zorn lisa.z...@sfcta.org Anyone? This is so frustrating because I now build two sets of sphinx documentation with the same code (sphinx 1.1.3) and similar conf.py files and one exhibits the problem and the other does not. I have made sure the problem set has no errors during documentation generation, I'm just not sure why one has the xref but the other one does not. -Lisa On Friday, August 17, 2012 12:29:16 PM UTC-7, Lisa Zorn wrote: Hello -- I was using sphinx 1.0.7 and autosummary to generate html for my python module. I recently upgraded to sphinx 1.1.3 and now for the class pages, the methods no longer link to their documentation. old: http://dta.googlecode.**com/git-history/** 4f593ec661fe5309ad0af5f027aefb**02519fd726/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html new: http://dta.googlecode.**com/git-history/** 55ccd338da95c0ff6c41ddee187565**5d2023039c/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html I have looked around for options and so forth that could have caused this but found nothing. My conf.py and index.rst are in here: http://code.google.com/**p/dta/source/browse/?name=dev#**git%2Fdochttp://code.google.com/p/dta/source/browse/?name=dev#git%2Fdoc Thank you for any assistance; I really need those links back because the pages are a hassle to use now. -Lisa -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/sdxnsdrr1PgJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: contextual help
there are many options in conf.py file. see this one: http://code.google.com/p/dta/source/browse/doc/conf.py?name=dev standard way in apache2 http server your first html file is named index.html (you could change this for any name that you want). if you use microsoft http server standard name is default.asp . all these are in sphinx doc page: http://sphinx.pocoo.org/latest/config.html#build-config 2012/10/26 Renato renato.pontef...@gmail.com Hi, maybe I've found a solution. with the make sphinx utility, I create directly the html file (make html, produce many html files) I'm wondering if is it possible to define the name of html. i.e. I can call my HTML produced file: 1.html 2.html Is it possible? I mean: what's the name that make give to html file? If it could be a particolar tag, that should be the solution. Isn't it? :-) Renato . Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/qhTSYe-ca5wJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] overriding field_name_limit
please is about this specs that you are talking? http://www.w3.org/TR/html401/struct/tables.html#h-11.2.4.2 ? 2012/10/21 Manolis Stamatogiannakis msta...@gmail.com Hello list, I am desperately trying to override the default field_name_limit for html4css1 writer, but in the end my html pages are always rendered with the default (14). This results in rendering the names of many fields with colspan=2 - which I am trying to avoid. To override the default field_name_limit I created a docutils.conf file with the following contents: # Documentation: http://docutils.sourceforge.net/docs/user/config.html [general] dump_settings: 1 dump_internals: 1 [html4css1 writer] field_name_limit: 40 The printout (produced by enabling dump_* settings) always shows: 'field_name_limit': 40. Still, this does not seem to be propagated to the HTMLTranslator class (in html4css1/__init__.py). So its visit_field_name() always uses the default value of 14. I don't know if I am doing things the wrong way or if this is a bug. Any help would be greatly appreciated. Thank you! Manolis -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/FtT1UfDFivoJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: autosummary no longer links methods in the class to documentation
Hello -- I don't think needs_sphinx is relevant, as I know what sphinx I am using and my understanding is that using this setting would cause sphinx to error if I try to use an older sphinx. I have read everything I could find about autogen and autosummary. I am able to successfully use these settings, and automatically generate documentation for my python classes. The problem that I am having is that the table list of methods in the automatically generated documentation does not have the xref links to the actual documentation below. From my original post: *previously generated doc, with links*: http://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html *more recently generated doc, without links*: http://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html What I have been unable to figure out is why is the table not linking to the documentation? I have also generated documentation for another project (so using the same version of sphinx) with very similar configuration and the *links are there*. So something must have gone wrong with my documentation generation for this one project causing the links not to show up, but I have not been able to figure out what it is. -Lisa On Monday, October 29, 2012 8:18:12 AM UTC-7, gsavix wrote: try force this in your conf.py to your 1.1.3 and see logs and results. # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' 2012/10/29 gilberto dos santos alves gsa...@gmail.com javascript: if i understand your issue, have you see this entire documentation more detailed information about *sphinx-autogen* – generate autodoc stub pageshttp://sphinx.pocoo.org/latest/ext/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages The *sphinx-autogen* script can be used to conveniently generate stub documentation pages for items included in autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary listings. For example, the command $ sphinx-autogen -o generated *.rst please what is your operation system, and python version? are you verified variables PATH and PYTHONPATH to assure that they point for your new sphinx versions? best regards http://sphinx.pocoo.org/latest/ext/autosummary.html#module-sphinx.ext.autosummary 2012/10/25 Lisa Zorn lisa...@sfcta.org javascript: Anyone? This is so frustrating because I now build two sets of sphinx documentation with the same code (sphinx 1.1.3) and similar conf.py files and one exhibits the problem and the other does not. I have made sure the problem set has no errors during documentation generation, I'm just not sure why one has the xref but the other one does not. -Lisa On Friday, August 17, 2012 12:29:16 PM UTC-7, Lisa Zorn wrote: Hello -- I was using sphinx 1.0.7 and autosummary to generate html for my python module. I recently upgraded to sphinx 1.1.3 and now for the class pages, the methods no longer link to their documentation. old: http://dta.googlecode.**com/git-history/** 4f593ec661fe5309ad0af5f027aefb**02519fd726/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html new: http://dta.googlecode.**com/git-history/** 55ccd338da95c0ff6c41ddee187565**5d2023039c/doc/_build/html/_** generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html I have looked around for options and so forth that could have caused this but found nothing. My conf.py and index.rst are in here: http://code.google.com/**p/dta/source/browse/?name=dev#**git%2Fdochttp://code.google.com/p/dta/source/browse/?name=dev#git%2Fdoc Thank you for any assistance; I really need those links back because the pages are a hassle to use now. -Lisa -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/sdxnsdrr1PgJ. To post to this group, send email to sphin...@googlegroups.comjavascript: . To unsubscribe from this group, send email to sphinx-dev+...@googlegroups.com javascript:. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/B_WWI931AjQJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send
Re: [sphinx-dev] Re: contextual help
yes now i understand and i am think solutions/alternatives! 2012/10/29 Renato Pontefice renato.pontef...@gmail.com Hi Gilberto, thankyou for your tip, but my prob is that I don't solve my prob just changing the name of the produced HTML file. I mean: I need to have particular file name, i.e. the name of the secion or subsection. I.e. if in my HTML file, I write help for the dir command, I would have a dir.html file, that the java programmer can use when they write the code that will call the help page, Of course all this should be dinamicaly, otherwise I have to hard write the name on the code. Instead I would have an algorithm that can calculate the name in the conf.py and use the same algorithm in the java side to calculate the name of the html that should be call. do I made a good explanation? :-o Renato 2012/10/29 gilberto dos santos alves gsa...@gmail.com: there are many options in conf.py file. see this one: http://code.google.com/p/dta/source/browse/doc/conf.py?name=dev standard way in apache2 http server your first html file is named index.html (you could change this for any name that you want). if you use microsoft http server standard name is default.asp . all these are in sphinx doc page: http://sphinx.pocoo.org/latest/config.html#build-config 2012/10/26 Renato renato.pontef...@gmail.com Hi, maybe I've found a solution. with the make sphinx utility, I create directly the html file (make html, produce many html files) I'm wondering if is it possible to define the name of html. i.e. I can call my HTML produced file: 1.html 2.html Is it possible? I mean: what's the name that make give to html file? If it could be a particolar tag, that should be the solution. Isn't it? :-) Renato . Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/qhTSYe-ca5wJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: contextual help
please see at http://auvix.com.br/index.html in sumário (contents in portuguese) we have all links for all boletim pages (like http://auvix.com.br/boletim.html , http://auvix.com.br/odisseia.html) each ones is a html page created automatically by sphinx (see fonte / source rest) every link (see html source) are predefined books that i need show to readers in one public library (i think in your case a help for a command) see that context (place were) you click goes to diferente pages that is automatic addressed by sphinx creation of html files. this solve your issues? best regards 2012/10/29 gilberto dos santos alves gsa...@gmail.com yes now i understand and i am think solutions/alternatives! 2012/10/29 Renato Pontefice renato.pontef...@gmail.com Hi Gilberto, thankyou for your tip, but my prob is that I don't solve my prob just changing the name of the produced HTML file. I mean: I need to have particular file name, i.e. the name of the secion or subsection. I.e. if in my HTML file, I write help for the dir command, I would have a dir.html file, that the java programmer can use when they write the code that will call the help page, Of course all this should be dinamicaly, otherwise I have to hard write the name on the code. Instead I would have an algorithm that can calculate the name in the conf.py and use the same algorithm in the java side to calculate the name of the html that should be call. do I made a good explanation? :-o Renato 2012/10/29 gilberto dos santos alves gsa...@gmail.com: there are many options in conf.py file. see this one: http://code.google.com/p/dta/source/browse/doc/conf.py?name=dev standard way in apache2 http server your first html file is named index.html (you could change this for any name that you want). if you use microsoft http server standard name is default.asp . all these are in sphinx doc page: http://sphinx.pocoo.org/latest/config.html#build-config 2012/10/26 Renato renato.pontef...@gmail.com Hi, maybe I've found a solution. with the make sphinx utility, I create directly the html file (make html, produce many html files) I'm wondering if is it possible to define the name of html. i.e. I can call my HTML produced file: 1.html 2.html Is it possible? I mean: what's the name that make give to html file? If it could be a particolar tag, that should be the solution. Isn't it? :-) Renato . Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato Il giorno giovedì 25 ottobre 2012 10:42:50 UTC+2, Renato ha scritto: Hi, in my project (java project) the user view the various function of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? TIA Renato -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/qhTSYe-ca5wJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at
Re: [sphinx-dev] Re: autosummary no longer links methods in the class to documentation
in this fragment of your new doc (line 126-134 of html source), i could see class=xref created, but with new visual enhanced row-even / odd for separators? what i miss, please? fragment=begin tr class=row-eventdtt class=xref py py-obj docutils literalspan class=pregetNumAttachedConnectors/span/tt()/td tdReturn the number of connectors attached to this Centroid./td /tr tr class= row-oddtdtt class=xref py py-obj docutils literalspan class=pre getNumIncomingConnectors/span/tt()/td tdReturn the number of incoming connectors./td /tr tr class=row-eventdtt class=xref py py-obj docutils literalspan class=pregetNumIncomingLinks/span/tt() /td tdReturns the number of incoming links./td /tr fragment=end 2012/10/29 Lisa Zorn lisa.z...@sfcta.org Hello -- I don't think needs_sphinx is relevant, as I know what sphinx I am using and my understanding is that using this setting would cause sphinx to error if I try to use an older sphinx. I have read everything I could find about autogen and autosummary. I am able to successfully use these settings, and automatically generate documentation for my python classes. The problem that I am having is that the table list of methods in the automatically generated documentation does not have the xref links to the actual documentation below. From my original post: *previously generated doc, with links*: http://dta.googlecode.** com/git-history/**4f593ec661fe5309ad0af5f027aefb** 02519fd726/doc/_build/html/_**generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html *more recently generated doc, without links*: http://dta.googlecode.** com/git-history/**55ccd338da95c0ff6c41ddee187565** 5d2023039c/doc/_build/html/_**generated/dta.Centroid.htmlhttp://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html What I have been unable to figure out is why is the table not linking to the documentation? I have also generated documentation for another project (so using the same version of sphinx) with very similar configuration and the *links are there*. So something must have gone wrong with my documentation generation for this one project causing the links not to show up, but I have not been able to figure out what it is. -Lisa On Monday, October 29, 2012 8:18:12 AM UTC-7, gsavix wrote: try force this in your conf.py to your 1.1.3 and see logs and results. # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' 2012/10/29 gilberto dos santos alves gsa...@gmail.com if i understand your issue, have you see this entire documentation more detailed information about *sphinx-autogen* – generate autodoc stub pageshttp://sphinx.pocoo.org/latest/ext/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages The *sphinx-autogen* script can be used to conveniently generate stub documentation pages for items included in autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary listings. For example, the command $ sphinx-autogen -o generated *.rst please what is your operation system, and python version? are you verified variables PATH and PYTHONPATH to assure that they point for your new sphinx versions? best regards http://sphinx.pocoo.org/**latest/ext/autosummary.html#** module-sphinx.ext.autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#module-sphinx.ext.autosummary 2012/10/25 Lisa Zorn lisa...@sfcta.org Anyone? This is so frustrating because I now build two sets of sphinx documentation with the same code (sphinx 1.1.3) and similar conf.py files and one exhibits the problem and the other does not. I have made sure the problem set has no errors during documentation generation, I'm just not sure why one has the xref but the other one does not. -Lisa On Friday, August 17, 2012 12:29:16 PM UTC-7, Lisa Zorn wrote: Hello -- I was using sphinx 1.0.7 and autosummary to generate html for my python module. I recently upgraded to sphinx 1.1.3 and now for the class pages, the methods no longer link to their documentation. old: http://dta.googlecode.**com**/git-history/**4f593ec661fe5309a** d0af5f027aefb**02519fd726/doc/_**build/html/_**generated/dta.** Centroid.htmlhttp://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc/_build/html/_generated/dta.Centroid.html new: http://dta.googlecode.**com**/git-history/**55ccd338da95c0ff6** c41ddee187565**5d2023039c/doc/_**build/html/_**generated/dta.** Centroid.htmlhttp://dta.googlecode.com/git-history/55ccd338da95c0ff6c41ddee1875655d2023039c/doc/_build/html/_generated/dta.Centroid.html I have looked around for options and so forth that could have caused this but found nothing. My conf.py and index.rst are in here:
Re: [sphinx-dev] Sphinx: Co-Maintainer(s) wanted
Hi Georg, I would like to help maintain and work on Sphinx. Having worked on the Texinfo builder and contributed a few patches on other components, I'm fairly familiar with the project. If you want to give me push access to the main repo on Bitbucket, I could start by fixing / closing some of the smaller issues. My user name is jonwaltman. I'll be sure to discuss any major changes before committing. If I do happen to make changes that you have questions about or disagree with, please let me know so they can fixed or reverted; you won't hurt my feelings :) -- Jonathan Waltman -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Sphinx testsuite fails with Python 3.3 — help needed
Hi Dmitry, I'm trying to fix Sphinx test errors with Python-3.3. Test will succeed sometimes and fail sometimes. I replied to the report #1008. Best regards, -- Takayuki SHIMIZUKAWA Sphinx-users.jp 2012/10/24 Dmitry Shachnev mity...@gmail.com: Hi everybody! I'm Debian/Ubuntu developer and I've been investigating various Sphinx issues recently. But I got stuck at this one — Sphinx testsuite fails with Python 3.3 (which is the latest stable version), which makes the package fail to build. - Extract from the build log: http://paste.ubuntu.com/1300012/; - Bug report: https://bitbucket.org/birkenfeld/sphinx/issue/1008/test-failures-with-python-33. Does anybody know the reason why these tests fail? At least — is that Sphinx or Python issue? And where is the code that needs to be fixed? Note that you need to have the latest svn snapshot of docutils installed to run the test suite. Thanks in advance, -- Dmitry Shachnev -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
