[sphinx-dev] getting rid of (built-in function) in index
Sphinx-1.0.7 on FreeBSD-9 with Python-2.6.6. trying to use sphinx for documentation of a javascript library, which consist of a bunch of top-level functions. how do i get rid of the (built-in function) appendix in the generated index? those functions surely aren't built-in in any sense. -- roman -- 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.
cross-referencing warnings
Hello. I would like to find all places, where I made mistake in cross- referencing. Is there some flag, I should turn-on, in order to see all places Sphinx was not able to resolve the reference? Thanks. --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Another website uses Sphinx
Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project ( http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file Thanks a lot. --~--~-~--~~~---~--~~ 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: Another website uses Sphinx
On Feb 16, 12:56 am, Max Battcher m...@worldmaker.net wrote: Roman wrote: Hello. I would like to say thank you for all Sphinx developers! C\C++ Python language binding project (http://language-binding.net/index.html ) is another Sphinx happy user. By the way, the idea to put all configuration into a Python file is a brilliant. Using it, I was able: * to check my embedded documentation for spelling errors * to generate documentation with few different layouts: - on-line ( with AdSense ) - off-line * to generate sitemap.xml.gz file Neat. Would you care to share some/all of the techniques that you used in your config? I could see there being at least one or two generally useful recipes from what you cooked up. Okey, I will post them in a different threads --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Generating sitemap with Sphinx
Hello. I hope the following recipe will be found useful. Since Sphinx uses regular Python file, it is possible to use regular Python modules :-). To be specific, you can use :mod:atexit and sitemap_gen module @atexit.register def generate_sitemap(): if 'www' not in outdir: return try: import sitemap_gen config = your site xml configuration write file to the disk sitemap = sitemap_gen.CreateSitemapFromFile(path to the file, True) if not sitemap: print 'ERROR(SITEMAP): configuration file errors' else: sitemap.Generate() print 'ERRORS(SITEMAP): %d' % sitemap_gen.output.num_errors print 'WARNINGS(SITEMAP): %d' % sitemap_gen.output.num_warns except Exception, error: print ERROR(SITEMAP): sitemap file was not generated - , str (error) Thus, every time you update the documentation, sitemap will be updated to. The complete and working source code could be found here:http:// pygccxml.svn.sourceforge.net/viewvc/pygccxml/sphinx/conf.py? view=markup Enjoy. --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
pydsc - Python documentation string spell checker
Hello. Sometime ago, I wrote module, that checks all documentation strings and comments for spelling errors. Now, I use Sphinx for documentation and pydsc integrates nicely with it. The following is cut-and-paste of code from my conf.py file: try: import pydsc #report errors related to the project only pydsc.include_paths( project_root ) pydsc.ignore_dictionary( 'ignore_dictionary.txt' ) pydsc.set_text_preprocessor( pydsc.sphinx_preprocessor ) import pygccxml import pyplusplus except: pass #it is possible that pyenchant is not installed Every module imported after pydsc will be checked for errors. The documentation and other examples you can find here: http://language-binding.net/pydsc/pydsc.html pydsc has one advantage over other spell checkers. It tries to exclude code examples and identifiers from being checked, which decrease the number of errors from spell checker. So you actually see real errors, almost without noise. I use pydsc for both my projects and it works fine for me. May be you will find it useful for you too. Your comments are welcome. --~--~-~--~~~---~--~~ 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: 0.6 release (was Re: Pycon 2009 and Autosummary)
On Feb 16, 1:04 am, Georg Brandl ge...@python.org wrote: percious schrieb: Thanks Georg, When is 0.6 scheduled for release? Soon! I'd like to use this as an opportunity to talk a bit about 0.6: the inclusion of autosummary and/or an autogen script is the last thing missing now. What has landed in trunk today is improved theming support, which I why I want to ask as many of you as possible to test their builds with the newest trunk version. I tried to keep backwards compatibility with previous ways of customization as much as possible, so in theory nothing should break. If it does, please tell me! Well, if you ask :-) I just tried new version of Sphinx and found that there were some changes in a layout. I extend some blocks from layout.html and now my site generated without sidebar ( table of contents, search and etc ). Right now, I don't have time to investigate what causes the problem, but I will do this today. The following is a link to extended layout.html file: http://pygccxml.svn.sourceforge.net/viewvc/pygccxml/sphinx/__templates_www/layout.html?revision=1678view=markup --~--~-~--~~~---~--~~ 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 autodoc errors
On Feb 15, 12:15 am, Georg Brandl ge...@python.org wrote: Roman schrieb: On Feb 9, 1:15 pm, Roman roman.yakove...@gmail.com wrote: On Feb 7, 9:29 pm, Georg Brandl ge...@python.org wrote: Actually I thought I'd fixed that long ago. A short test here looks like this: reading sources... concepts WARNING: /home/gbr/devel/sphinx/sphinx/cmdline.py:docstring of sphinx.cmdline.main:1: (WARNING/2) Inline emphasis start-string without end-string. i.e. the location where the docstring comes from is given in the warning message. How does your warning message look? The following is the cut-and-paste of the warnings section: (sorry for the length) I was able to remove all warnings, except the following one: WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:160: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:406: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:408: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:108: (ERROR/3) Unknown target name: id. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:122: (ERROR/3) Unknown target name: id. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:27: (ERROR/3) Unknown target name: pygccxml. Does sphinx have debug mode? Can I configure it to print the text it worked on, before it printed the errors? docutils has strange behavior when working with documents with many different sources. I have worked around that for errors that happen immediately during parsing, but some errors are generated in a later stage, such as in your case during the resolving of references. I've now checked in a small change that helps e.g. in your case. I've also checked out your SVN, and the targets the warnings refer to are on: parser/source_reader.py line 60 parser/directory_cache.py line 463 parser/directory_cache.py line 482 declarations/type_traits.py line 257 and 259 declarations/type_traits.py line 429 Thank you very much!!! --~--~-~--~~~---~--~~ 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 autodoc errors
On Feb 9, 1:15 pm, Roman roman.yakove...@gmail.com wrote: On Feb 7, 9:29 pm, Georg Brandl ge...@python.org wrote: Actually I thought I'd fixed that long ago. A short test here looks like this: reading sources... concepts WARNING: /home/gbr/devel/sphinx/sphinx/cmdline.py:docstring of sphinx.cmdline.main:1: (WARNING/2) Inline emphasis start-string without end-string. i.e. the location where the docstring comes from is given in the warning message. How does your warning message look? The following is the cut-and-paste of the warnings section: (sorry for the length) I was able to remove all warnings, except the following one: WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:160: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:406: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ declarations.rest:408: (ERROR/3) Unknown target name: type. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:108: (ERROR/3) Unknown target name: id. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:122: (ERROR/3) Unknown target name: id. WARNING: /home/roman/language-binding/sources/sphinx/pygccxml/apidocs/ parser.rest:27: (ERROR/3) Unknown target name: pygccxml. Does sphinx have debug mode? Can I configure it to print the text it worked on, before it printed the errors? Thanks. --~--~-~--~~~---~--~~ 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 autodoc errors
On Feb 7, 9:29 pm, Georg Brandl ge...@python.org wrote: Actually I thought I'd fixed that long ago. A short test here looks like this: reading sources... concepts WARNING: /home/gbr/devel/sphinx/sphinx/cmdline.py:docstring of sphinx.cmdline.main:1: (WARNING/2) Inline emphasis start-string without end-string. i.e. the location where the docstring comes from is given in the warning message. How does your warning message look? The following is the cut-and-paste of the warnings section: (sorry for the length) WARNING: d:\dev\sphinx\pygccxml\apidocs\declarations.rest:160: (ERROR/ 3) Unknown target name: type. WARNING: d:\dev\sphinx\pygccxml\apidocs\declarations.rest:406: (ERROR/ 3) Unknown target name: type. WARNING: d:\dev\sphinx\pygccxml\apidocs\declarations.rest:408: (ERROR/ 3) Unknown target name: type. WARNING: d:\dev\pygccxml_dev\pygccxml\parser \directory_cache.py:docstring of pygccxml.parser.directory_cache.directory_cache_t:3: (WARNING/2) Inline emphasis start-string without end-string. WARNING: d:\dev\pygccxml_dev\pygccxml\parser \directory_cache.py:docstring of pygccxml.parser.directory_cache.directory_cache_t:3: (WARNING/2) Inline emphasis start-string without end-string. WARNING: d:\dev\pygccxml_dev\pygccxml\parser \directory_cache.py:docstring of pygccxml.parser.directory_cache.index_entry_t:3: (WARNING/2) Inline emphasis start-string without end-string. WARNING: d:\dev\sphinx\pygccxml\apidocs\parser.rest:107: (ERROR/3) Unknown target name: id. WARNING: d:\dev\sphinx\pygccxml\apidocs\parser.rest:121: (ERROR/3) Unknown target name: id. WARNING: d:\dev\sphinx\pygccxml\apidocs\parser.rest:27: (ERROR/3) Unknown target name: pygccxml. WARNING: d:\dev\sphinx\pyplusplus\documentation\apidocs \code_creators.rest:92: (WARNING/2) autodoc can't import/find module 'pyplusplus.code_creators.ctypes_module', it reported error: No module named import_, please check your spelling and sys.path WARNING: d:\dev\pyplusplus_dev\pyplusplus\decl_wrappers \algorithm.py:docstring of pyplusplus.decl_wrappers.algorithm.creators_affect_on_me:11: (WARNING/ 2) Line block ends without a blank line. WARNING: d:\dev\pyplusplus_dev\pyplusplus\decl_wrappers \algorithm.py:docstring of pyplusplus.decl_wrappers.algorithm.creators_affect_on_me:13: (WARNING/ 2) Line block ends without a blank line. WARNING: :0: (ERROR/3) Unexpected indentation. WARNING: d:\dev\pyplusplus_dev\pyplusplus\decl_wrappers \variable_wrapper.py:docstring of pyplusplus.decl_wrappers.variable_wrapper.variable_t.apply_smart_ptr_wa: 6: (WARNING/2) Block quote ends without a blank line; unexpected unindent. WARNING: :0: (ERROR/3) Unexpected indentation. WARNING: d:\dev\pyplusplus_dev\pyplusplus\decl_wrappers \variable_wrapper.py:docstring of pyplusplus.decl_wrappers.variable_wrapper.variable_t.use_make_functions: 6: (WARNING/2) Block quote ends without a blank line; unexpected unindent. WARNING: d:\dev\sphinx\pyplusplus\documentation\apidocs \decl_wrappers.rest:16: (ERROR/3) Unknown target name: type. WARNING: d:\dev\pyplusplus_dev\pyplusplus\file_writers \class_multiple_files.py:docstring of pyplusplus.file_writers.class_multiple_files:2: (ERROR/3) Unexpected indentation. WARNING: d:\dev\pyplusplus_dev\pyplusplus\function_transformers \transformers.py:docstring of pyplusplus.function_transformers.transformers.input_c_buffer_t:3: (WARNING/2) Inline emphasis start-string without end-string. WARNING: d:\dev\sphinx\pyplusplus\documentation\apidocs\messages.rest: 9: (WARNING/2) autodoc can't import/find module 'messages.warnings_', it reported error: No module named messages.warnings_, please check your spelling and sys.path WARNING: d:\dev\sphinx\pyplusplus\documentation\apidocs\messages.rest: 16: (WARNING/2) invalid signature for automodule (u'pyplusplus\ \messages') WARNING: d:\dev\sphinx\pyplusplus\documentation\apidocs\messages.rest: 16: (WARNING/2) don't know which module to import for autodocumenting u'pyplusplus\\messages' (try placing a module or currentmodule directive in the document, or giving an explicit module name) WARNING: d:\dev\pyplusplus_dev\pyplusplus\module_builder \boost_python_builder.py:docstring of pyplusplus.module_builder.boost_python_builder.builder_t.add_constants: 6: (WARNING/2) Inline strong start-string without end-string. How do you use autodoc? I need to know more to do a better diagnosis. = pygccxml.declarations package = algorithm - .. automodule:: pygccxml.declarations.algorithm :members: :show-inheritance: list of other modules from the sub package Thanks, Thank you! Let me know if you need more information. My project is open source: http://sourceforge.net/projects/pygccxml/ Basically, if you run sphinx-build . __build from ( http://pygccxml.svn.sourceforge.net/viewvc/pygccxml/sphinx/ ) directory you will get the warnings. --~--~-~--~~~---~--~~ You received this message because you are subscribed to
Re: How do I refer to another .rst file?
On Feb 1, 4:30 pm, Jorge Vargas jorge.var...@gmail.com wrote: On Sun, Feb 1, 2009 at 1:30 AM, Roman roman.yakove...@gmail.com wrote: Hello. My documentation contains links between different .rst files. Today, I only generate html documentation, so I know in advance the generated file name and refer to it, using reStructuredText functionality. I don't feel like this is the right way to go. Is there another way to go? hi, please search the list for this. short answer a) not easy with released version, you can get it semi-done with references, as shown herehttp://sphinx.pocoo.org/markup/inline.html#ref-role b) trunk has an implementation for this, lets hope for a release soon. Thanks. I took a look on http://bitbucket.org/birkenfeld/sphinx/src/tip/CHANGES . It looks like I am going to switch to development version :-) --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
How do I refer to another .rst file?
Hello. My documentation contains links between different .rst files. Today, I only generate html documentation, so I know in advance the generated file name and refer to it, using reStructuredText functionality. I don't feel like this is the right way to go. Is there another way to go? Thanks --~--~-~--~~~---~--~~ 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: Script to autogenerate the necessary ReST files to build automatically the docs from the code
On Jan 16, 10:07 pm, etienne.desaut...@gmail.com wrote: Hi, Good evening. I start to use Sphinx for our project (http://propulseart.sat.qc.ca) and I wish to autogenerate all the docs from the code (à la epydoc). So I have written a script that parse the directory tree of a project/ package and create all the ReST files (with the automodule directive in it) necessary to produce the docs from the code. I was wondering if you think it could be a good idea to bundle a script of this kind with Sphinx? I tried your script and it did the job quite nice. Correct me if I wrong, but this is one time script - I can run it only once. If I modify the generated files, the script will not preserve the changes. May be the better solution is to add :autopackage: directive, which has the following properrties/attributes: * understand __init__.py file role * :maxdepth: * support merge of hand-written documentation and the one extracted from code ( http://sphinx.pocoo.org/ext/autodoc.html?highlight=autodoc#module-sphinx.ext.autodoc ), * include/exclude glob patterns May be Sphinx should introduce :pkg: directive, which allows to refer to the whole package. What do you think? --~--~-~--~~~---~--~~ 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: connection between stand-alone documentation and source code
On Jan 28, 8:15 am, Roger Binns rog...@rogerbinns.com wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Roman wrote: I am just starting with Sphinx and I cant understand how I should integrate regular documentation with the one, extracted from the source code? In your conf.py, have this: extensions = ['sphinx.ext.autodoc'] To document a module, create a .rst file with this as an example database.rst. Database code = .. automodule:: database :members: :undoc-members: You could add more modules to that one file. In your index.rst add the rst filenames without the rst extension. Contents: .. toctree:: :maxdepth: 2 gui database podcast util test Thank you. Meanwhile, I found Sphinx tutorials at Pylons book: http://pylonsbook.com/alpha1/documenting_a_pylons_project This is a really nice introduction to Sphinx. --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
connection between stand-alone documentation and source code
Hello. Any help with the following issue is appreciated. I am just starting with Sphinx and I cant understand how I should integrate regular documentation with the one, extracted from the source code? Where I configure the location of source code? I read the documentation, took a look on few projects. All of them has modules link, but I cant find in the conf.py or in the .rst files where the source code location is set or mentioned. Another question, it there is a tutorial project somewhere? I mean simple\dummy Python package with dummy documentation. So, it could be possible to study or play with it, and than do apply the result to the real project. Thanks in advance. --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
