[sphinx-users] Survey of Sphinx extensions

Hello, I made a list of sphinx extensions (for presentation at SphinxCon JP 2014). Currently, it includes 230 extensions. http://sphinxext-survey.readthedocs.org/en/latest/ It is based on searchs from PyPI and Googles (mainly github, gist and bitbucket). The extensions are classified into 18 cat

[sphinx-users] Re: sphinx 1.3.4 latex gives no toc

Hi, Sorry for inconvinience. It's bug of 1.3.4 And will fixed at 1.3.5. Please use 1.3.3 until next version is released (may be this weekend). Thank you for reporting Takeshi KOMIYA 2016年1月21日木曜日 8時17分39秒 UTC+9 repriville: > > > I upgraded to sphinx 1.3.4 in a python 2.7.8 virtual environment.

[sphinx-users] Re: 1.3.5 problem with latex tocdepth

Hi, Sorry for inconvinience. Since 1.3.5, LaTeX writer supports :maxdepth: option for toctree directive. It sets up `tocdepth` counter if :maxdepth: found. So please set up your :maxdepth: option. BTW, it seems worse that the `tocdepth` counter is defined after latex_elements['preamble']. I'll

Re: [sphinx-users] Re: 1.3.5 problem with latex tocdepth

his, the resulting .tex file always states >> "\setcounter{tocdepth}{1}". However, what we need is a "master" setting >> in the conf.py file, to set the "tocdepth" counter for latex. >> >> Can you please explain how to set the tocdepth in the conf.py

[sphinx-users] Re: Sphinx 1.4-alpha1 released

Hi Viktor, This difficulty seems to still be there with the 1.4b1 release. > > In my particular case, I'm getting the errors associated with a domain > extension contrib package that has gone asleep by maintainers, and I tried > to modify a bit to use Python 3. I have gone over my adjustments t

[sphinx-users] Re: Sphinx 1.4-alpha1 released

Hi, I'm glad to hear that. If you find any other issues, please tell me them :-) Thanks, 2016年3月8日火曜日 22時42分35秒 UTC+9 Viktor Haag: > > > On Tuesday, 8 March 2016 07:28:06 UTC-5, Komiya Takeshi wrote: >> >> Oh, sorry. We do not intend to make the 3rd party domains inc

[sphinx-users] Sphinx 1.4.2 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.2, now available on the Python package index at . It includes about 4 features and 44 bug fixes for the 1.4.1 release series, among them a incompatibility and a packaging error. For the full changelo

Re: [sphinx-users] Sphinx 1.4.2 released

g to the following image directive that I > use, that points to a remote URL: > > .. image:: > > http://demo.mapserver.org/cgi-bin/mapserv?map=/osgeo/mapserver/tutorial/htdocs/example1-1.map&layer=states&mode=map > > > This works fine in 1.4.1 and all past Sp

Re: [sphinx-users] Sphinx in Laravel

Hi, Unfortunately, this is not a list for sphinx-search. this is for sphinx; the documentation tool. http://www.sphinx-doc.org/en/stable/ Please ask your question at more suitable list. Thanks, Takeshi KOMIYA 2016-05-31 17:06 GMT+09:00 Sandeep kaur : > Greetings, > I am trying to use sphinx in

[sphinx-users] Re: Execute something like autodoc without run the code is posible?

Hi, Technically, it is possible to generate docs without execution. But sphinx.ext.autodoc does not support the feature. It might work combination of doxygen and breathe extension (but I'd never used them...) Thanks, Takeshi KOMIYA 2016年6月4日土曜日 20時54分32秒 UTC+9 Juan Antonio Fernández Sánchez: >

[sphinx-users] Sphinx-1.4.3 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.3, now available on the Python package index at . It includes about 1 packaging bug and 10 bug fixes for the 1.4.2 release series, among them a incompatibility and a packaging error. For the full cha

[sphinx-users] Sphinx-1.4.4 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.4, now available on the Python package index at . It includes about 10 bug fixes for the 1.4.3 release series, among them a incompatibility and a packaging error. For the full changelog, go to < http:

[sphinx-users] Re: Unknown interpreted text role "kbd"

Hi, The `kdb` role is not a part of standard reStructuredText. It is additional role. So it works under Sphinx only. Thanks, Takeshi KOMIYA 2016年6月17日金曜日 9時10分52秒 UTC+9 Vladan Divljak: > > Hi, > > I'm starting with Sphinx and rst, and thought to try with `kbd` directive > as shown in documenta

[sphinx-users] Re: How to change the name "Table of Contents" in HTML sidebars

Hi, You can customize the caption of ToC by template. For example, putting following code as _templates/localtoc.html changes the title. TOC {{ toc }} More details, please refer the templating: http://www.sphinx-doc.org/en/stable/templating.html Thanks, Takeshi KOMIYA 2016年6月23日木曜日 8時55分50秒

[sphinx-users] Re: Is it possible to use reference inside rubric?

Hi, Do you want to change the "AUTHOR1" in first paragraph downloadable? If true, you can use hyperlink target syntax. ex: Following AUTHOR1_ blablabla .. _AUTHOR1: _static/author1.pdf Thanks, Takeshi KOMIYA 2016年6月25日土曜日 7時54分15秒 UTC+9 Lauro: > > *Example:* > > Following [AUTHOR1]_ b

[sphinx-users] Re: Problem in generating TOC

Hi, It seems globbing are nested. Did you have a sub index file in these sub directories like following? main .. toctree:: :glob: * If true, project_root/index.rst should refer them: .. toctree:: main/index python_tools/index Thanks, Takeshi KOMIYA 2016年6月25日土曜日 7時54分15秒 U

[sphinx-users] Re: Problem in generating TOC

Hi, The filename is not important. I meant is there sub toctree like following is in your sub directories. .. toctree:: :glob: * It seems your situation is similar to the case of sub toctrees. Is the way you suggested the right way to do the index? I don't know my approach is right or

[sphinx-users] Re: disable search index generation

Hi, There is no way to disable the feature in the proper way. As a workaround, the following code is able to do that. def on_builder_inited(app): if app.builder.name == 'html': app.builder.search = False def setup(app): app.connect('builder-inited', on_builder_inited) This is

[sphinx-users] Re: How to change the name "Table of Contents" in HTML sidebars

it with globaltoc (same thing but with {{ > toctree() }} at the bottom), but I am worried that I will omit important > parts of the original globaltoc if _templates/globaltoc.html overwrites the > built-in globaltoc. > > > On Friday, June 24, 2016 at 11:31:10 AM UTC-4, Komiya T

[sphinx-users] Re: How to change the name "Table of Contents" in HTML sidebars

it with globaltoc (same thing but with {{ > toctree() }} at the bottom), but I am worried that I will omit important > parts of the original globaltoc if _templates/globaltoc.html overwrites the > built-in globaltoc. > > > On Friday, June 24, 2016 at 11:31:10 AM UTC-4, Komiya T

[sphinx-users] Re: Doc/help on what's possible in custom toc templates for html sidebar

Hi, >2) How do I know what affordances exist like {{ toc }} or {{ toctree() }} and what they do? >3) Are there other variables or functions that might be useful? Please read this page. It introduces variables and functions sphinx provides. http://www.sphinx-doc.org/en/stable/templating.html

[sphinx-users] Re: document IronPython

Hi, I don't know that. but sphinx does not have a special restriction to running environment. So it might work. Please try it and report the result! Thanks, 2016年7月4日月曜日 15時05分34秒 UTC+9 Ilan: > > Hi, > Is it possible to document IronPython code with sphinx > Thanks, > Ilan > -- You received t

[sphinx-users] Re: Inline replacement of directive with another directive

Hi, You can do it by generating `graphviz` node on your directive: from sphinx.ext.graphviz import graphviz class YourDirective(Directive): def run(self): ... graph = graphviz('', code='digraph { ... }') return [graph] Thanks, 2016年7月4日月曜日 8時27分09秒 UTC+9 Florian: > >

[sphinx-users] Re: Inline replacement of directive with another directive

ib-pylint/commit/a2fc984a6bdab3927031a589d23cb0017629636b > ). > Thanks a lot. > > Am Donnerstag, 7. Juli 2016 11:36:19 UTC+2 schrieb Florian: >> >> I will give it a try... Thanks. >> >> Am Mittwoch, 6. Juli 2016 18:52:09 UTC+2 schrieb Komiya Takeshi: >>>

[sphinx-users] Re: sphinx xmlpipe2 - increase 2 MB limit

Hi, This is a list for sphinx; the documentation tool. not for sphinx search. http://www.sphinx-doc.org/en/stable/ Thanks, Takeshi KOMIYA 2016年7月9日土曜日 9時12分02秒 UTC+9 Юрий Кудряшов: > > Hi, everybody. > > I see in documentation (http://sphinxsearch.com/docs/current/xmlpipe2.html > ). > > fields l

[sphinx-users] Re: Access to config when defining a new directive

Hi, You can refer the config object using "self.state.document.settings.env.config" in Directive.run() method. Thanks, Takeshi KOMIYA 2016年7月9日土曜日 7時53分37秒 UTC+9 Ryszard Kubiak: > > Hi everybody, > > I wonder if config values, the ones defined in the conf.py file, can be > reached somehow fro

[sphinx-users] Sphinx-1.4.5 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.5, now available on the Python package index at . It includes about 2 incompatible changes, 3 features added and 22 bug fixes for the 1.4.4 release series. For the full changelog, go to < http://www.s

[sphinx-users] Re: AttributeError: module 'distutils.config' has no attribute 'ConfigParser'

Hi, It seems the exception comes from your configuration file. Could you check line 48 of your conf.py? > File "conf.py", line 48, in >AttributeError: module 'distutils.config' has no attribute 'ConfigParser' Thanks, Takeshi KOMIYA 2016年7月28日木曜日 6時25分10秒 UTC+9 Lian Tao: > > Hello, > > > When

[sphinx-users] Re: html_last_updated not working?

Hi, What theme are you using? Unfortunately, the default theme of Sphinx; alabaster does not support the configuration. We need to report that to alabaster project. Note: I confirmed it works with the "classic" theme. Thanks, Takeshi KOMIYA 2016年7月28日木曜日 6時25分13秒 UTC+9 EMK: > > *Note:* I'm sti

[sphinx-users] Re: Conditional bullet list items

Hi, The "only" directive is not a preprocessor. Actually, it works as post-processor. In your situation, the input reST is recognized like following: New glunkifier for fribulating text. (eight more entries here) Zoodler has been enhanced. Numbulator now handles XQT48.

[sphinx-users] Re: help about how "breadcrumbs" (relbar "parents" list) work

Hi, Following custom template will help you. {%- extends "classic/layout.html" %} {%- block relbaritems %} {%- if master_doc != pagename %} {{ title|striptags|e }} {% endif %} {% endblock %} Please put this file to _templates/layout.html on your project. This appends a link to current document

[sphinx-users] Re: working with REVTeX

Hi, Unfortunately, current Sphinx could not change the order of the \author definition. So you have to modify LaTeX writer directly as a ad-hoc way. I want to improve this in next major version. At master branch, I introduced a template file for LaTeX code. https://github.com/sphinx-doc/sphinx/b

[sphinx-users] Re: html_last_updated not working?

Hi, I got the result by following steps: $ virtualenv test $ cd test $ . bin/activate $ pip install Sphinx $ hash -r $ sphinx-quickstart doc (snip) $ cd doc $ echo "html_last_updated_fmt = '%B %d, %Y'" >> conf.py $ echo "html_theme = 'classic'" >> conf.py $ make html The screenshot of the documen

[sphinx-users] Re: TypeError: 'type' object does not support indexing error message when importing pymel.core module

Hi, This comes from bug of autodoc_mock_imports. I just fixed it at master branch. https://github.com/sphinx-doc/sphinx/commit/e15216c568015a713e26afd647b830b87781a164 Thanks, Takeshi KOMIYA 2016年7月27日水曜日 22時21分18秒 UTC+9 Abhilash Gupta: > > Hi Tomek, > > I am currently facing this same issue. Co

[sphinx-users] Re: Is there any way to format a Sphinx reference?

Hi, "Naming Convention" is surrounded by . So you can change the style of the references using CSS. Thanks, Takeshi KOMIYA 2016年8月9日火曜日 4時36分48秒 UTC+9 Jason S: > > http://stackoverflow.com/questions/38837051/formatting-a-sphinx-reference > > If I use this RST source: > > - :ref:`Naming Conventio

Re: [sphinx-users] Re: Figure caption problem with numfig

Hi, Do you use sphinxtr/numfig.py? It appends "Figure n:" automatically. https://github.com/jterrace/sphinxtr/blob/master/extensions/numfig.py#L124 Please tell me what extensions you are using. Thanks, Takeshi KOMIYA 2016年8月12日金曜日 5時27分45秒 UTC+9 Warren Block: > > On Thu, 11 Aug 2016, Peter Burd

Re: [sphinx-users] Re: Figure caption problem with numfig

Since Sphinx-1.3, Sphinx provides numfig feature as a built-in. So no extensions are needed now. It will go well if you remove the sphinx-numfig extension. Thanks, Takeshi KOMIYA 2016年8月12日金曜日 12時25分05秒 UTC+9 Warren Block: > > On Thu, 11 Aug 2016, Komiya Takeshi wrote: > > >

[sphinx-users] Re: logo problem with alabaster theme

Hi, Hmm... it might be a bug of alabaster theme. The configuration is ignored in my environment too. http://alabaster.readthedocs.io/en/latest/customization.html BTW, html_logo works fine for me. http://www.sphinx-doc.org/en/stable/config.html#confval-html_logo Please use it instead. Thanks, Ta

[sphinx-users] Re: overriding without changing templates?

Hi, Unfortunately, there is no way to replace doctype. Because sphinx does not support HTML5. At this moment, using HTMl5 themes (ex. sphinx-bootstrap-theme) is a simple way to do that. Thanks, Takeshi KOMIYA 2016年8月12日金曜日 1時13分32秒 UTC+9 Jason S: > > Is there a way to override to without chan

[sphinx-users] Re: Is there any way to format a Sphinx reference?

ar section use boldface terms in a bullet list. > > On Monday, August 8, 2016 at 8:34:23 PM UTC-7, Komiya Takeshi wrote: >> >> Hi, >> >> "Naming Convention" is surrounded by . >> So you can change the style of the references using CSS. >> >

[sphinx-users] Re: Getting generated HTML for a node and its children

Hi, How about sphinx.builders.html.StandaloneHTMLBuilder.render_partial()? It will generate HTML for specific node and its children. Thanks, Takeshi KOMIYA 2016年8月10日水曜日 8時48分41秒 UTC+9 Brad Miller: > > Hi, > > I've written a custom directive, which may contain other directives. All > is being

[sphinx-users] Re: Custom role in extension for latex vs html build

Hi, To registeri custom node is a standard way to do that. If added, you can add handlers for each builders:: from docutils import node class sidenote(nodes.Inline): pass def sidenote_role(...): """ Generate sidenote node from role definition """ role = sidenote() role['tag'] =

[sphinx-users] Re: how to get a superscript registered trademark (R) symbol?

Hi, The substitution does not work inside roles and directives. So you should use :sup:`®` . Thanks, Takeshi KOMIYA 2016年8月13日土曜日 6時34分30秒 UTC+9 Jason S: > > How can I superscript the ® symbol in Sphinx/RestructuredText? > > > The following does not work, I get a superscripted |reg| instead. >

[sphinx-users] Re: html_last_updated not working?

Hi, I don't know regular way to change the format of dates for each document. As a ad-hoc way, you can do that with python codes. The following code modifies the format of dates at runtime. from datetime import date def change_today_fmt(app, docname, source): if docname == 'foo': a

[sphinx-users] Re: Use toctree to display sibling pages?

Hi, It seems there are no special template variable to show a toctree for a specific document. The following code might help you:: def on_html_page_context(app, pagename, tempaltename, context, docname): # get ToC for "a" document toc_for_a = self.env.get_toc_for('a', self) # set up

[sphinx-users] Sphinx-1.4.6 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.6, now available on the Python package index at . It includes about 1 incompatible change and 12 bug fixes for the 1.4.5 release series. For the full changelog, go to < http://www.sphinx-doc.org/en/st

[sphinx-users] Re: Dependencies

Hi, six >= 1.5 is required at Sphinx-1.4.6. it is only changes in dependencies between 1.4.4 and 1.4.6 Thanks, 2016年8月23日火曜日 8時12分04秒 UTC+9 Peter Burdine: > > I agree. Below is the list I have for 1.4.4 (plus some extensions we > use), has it changed for 1.4.6? > > >- alabaster-0.7.8-py2.p

[sphinx-users] Re: Sphinx Pygment Style Jellybeans does not show right background

Hi, It seems the jellybeans theme sets the background color of tokens to #151515 (nearly black). https://github.com/cstrahan/pygments-styles/blob/master/themes/jellybeans.py But alabaster; the default theme of sphinx uses white as a background color of code-blocks. Maybe, you should change it u

[sphinx-users] Re: Is there any way to automatically add section titles to the genindex?

Hi, To my knowlege, Sphinx does not have such a feature. And I don't know such an extension too. To do that, you might need to make new extension. Thanks, Takeshi KOMIYA 2016年8月27日土曜日 1時24分06秒 UTC+9 Jason S: > > I'm relatively new to Sphinx and I am not using it for Python. I went to > the gen

[sphinx-users] Re: numref with number and caption

Hi, It's good idea. Please post your proposal to github issues. I will implement it in future (maybe in 1.5 or 1.6). Thanks, Takeshi KOMIYA 2016年8月26日金曜日 6時17分02秒 UTC+9 Warren Block: > > I would like a numref-like role that inserts both a table or figure > number *and* the the linked object's c

[sphinx-users] Re: Sphinx Pygment Style Jellybeans does not show right background

und color style in Sphinx-Doc? > > > > On Wednesday, August 24, 2016 at 10:05:50 PM UTC-5, Komiya Takeshi wrote: >> >> Hi, >> >> It seems the jellybeans theme sets the background color of tokens to >> #151515 (nearly black). >> >> https://githu

[sphinx-users] Re: xrefs to equations - not working

Hi, Did you try to reference equations between different document? If true, current release does not support it. Please wait next major release. Otherwise it's strange. Could you share any example of your docs? It seems the code you pasted here includes needless spaces. I want to see actually us

[sphinx-users] Re: xrefs to equations - not working

Hi, Yes, please :-) Takeshi KOMIYA 2016年8月31日水曜日 8時27分55秒 UTC+9 Fiona Hanington: > > Hi > I am having trouble posting a zip file. Can I send to you directly? > Fiona > > On Monday, 29 August 2016 19:30:40 UTC-7, Komiya Takeshi wrote: >> >> Hi, >> >>

[sphinx-users] Re: xrefs to equations - not working

ience. And thank you for good report. Thanks, Takeshi KOMIYA 2016年8月31日水曜日 10時18分54秒 UTC+9 Komiya Takeshi: > > Hi, > > Yes, please :-) > > Takeshi KOMIYA > > 2016年8月31日水曜日 8時27分55秒 UTC+9 Fiona Hanington: >> >> Hi >> I am having trouble posting a zip file

Re: [sphinx-users] Re: xrefs to equations - not working

Yes, removing nowrap option is a ad-hoc way. Thanks, Takeshi KOMIYA 2016年9月1日木曜日 6時19分17秒 UTC+9 Fiona Hanington: > > Does this mean my xref will work if I remove nowrap? > > Thanks > > On Wed, Aug 31, 2016 at 10:17 AM, Komiya Takeshi > wrote: > >> Hi Fiona, >&g

[sphinx-users] Re: Role functions have an inliner, how do I get it from within a Directive?

Hi, You can use self.state.nested_parse() instead at Directive.run(). Thanks, Takeshi KOMIYA 2016年9月7日水曜日 3時45分06秒 UTC+9 Jason S: > > Custom role functions have an inliner: > > def myrole(role, rawtext, text, lineno, inliner, options={}, content=[]): > > ... > > > But what about a custom

[sphinx-users] Re: Numbered start/offset for multiple toctrees?

Hi, You can give section number to :numbered: option of toctree directive. .. toctree:: :caption: Part I :numbered: 1 foo bar .. toctree:: :caption: Part II :numbered: 1 baz qux But unfortunately, this feature is imcomplete. This effects to only HTML builder. Other bui

[sphinx-users] Re: Is there any way to format an index entry in monospace?

Hi, Please use stylesheet to change the looks of HTMLs. Thanks, Takeshi KOMIYA 2016年9月3日土曜日 7時58分56秒 UTC+9 Jason S: > > I want to format certain index entries in monospace, because they are > program identifiers (instead of index terms). > > How can I do this? > -- You received this message b

[sphinx-users] Re: call Sphinx from Python3

Hi, Unfortunately, there are no way to reset them. Note: It is reported as https://github.com/sphinx-doc/sphinx/issues/2687 Thanks, Takeshi KOMIYA 2016年9月7日水曜日 17時33分17秒 UTC+9 Andrea Cassioli: > > Hi, > I am trying to call Sphinx directly from Python3. That would simplify my > workflow, as I ne

[sphinx-users] Re: Custom JSON output?

Hi, What parts do you want to access? Please tell me your idea in detail. Thanks, Takeshi KOMIYA 2016年9月8日木曜日 6時38分47秒 UTC+9 Thomas Schultz: > > Thanks for the reply! > > Sure, me see if I can make more sense of this. > > We have a javascript app that is generating a styled site from JSON that's

[sphinx-users] Re: newby - trying to install numsec.py extension so I can reference section numbers

Hi, I've never used the extension, but it might work with following steps: 1. copy numsec.py into your project 2. rewrite your conf.py to add current directory into sys.path:: sys.path.insert(0, os.path.abspath('.')) 3. add "numsec" (without .py suffix) into extensions list extensions

[sphinx-users] Re: Safe to run untrusted Sphinx code?

Hi, As far as I know, building sphinx-doc is basically safety operation. But conf.py is recognized python script, so it is danger if conf.py is placed under untrusted directory. BTW, I've never use tikz extension. so I don't know about it. Thanks, Takeshi KOMIYA 2016年9月10日土曜日 7時31分24秒 UTC+9 Au

[sphinx-users] Re: Accessing the build directory in conf.py?

Hi, As far as I know, there are no proper way to obtain build directory in conf.py. But, as a adhoc way, you con obtain it through environment variables. in Makefile: BUILDDIR = _build export BUILDDIR in conf.py: builddir = os.environ['BUILDDIR'] jinja_contexts = {

[sphinx-users] Re: newby - trying to install numsec.py extension so I can reference section numbers

as the titles not the section > numbers. Anyone on this list use the extension? > > On Monday, 12 September 2016 08:24:24 UTC-7, Komiya Takeshi wrote: >> >> Hi, >> >> I've never used the extension, but it might work with following steps: >> >> 1. co

[sphinx-users] Re: PDF version shows one huge chapter? Table of contents issues with latexpdf

Hi, 1) All my contents go in one chapter, everything from all the toctrees > ends up as Chapter 1 for some reason. > Please check your index.rst. Is there "Contents" heading before toctree definition? If true, Sphinx recognized the heading is a top level chapter. > 2) Even though I have s

[sphinx-users] Re: Custom JSON output?

r required (or if default is present in signature) > - Return type and :returns: description string. > - All examples provided in the docstring. > > If I could access this information, I think it would be enough to get > started. > > Would it be best to access this information in

[sphinx-users] Re: How do I include a standard symbol with Caution and Warning directives

Hi, About HTML, please create a CSS to customize the warning box. On the other hands, about LaTeX, current release does not support customization. Unreleased v1.5 will support it using custom LaTeX macros. ref: https://github.com/sphinx-doc/sphinx/issues/2674 Thanks, Takeshi KOMIYA 2016年9月15日木

[sphinx-users] Sphinx-1.5a1 has been released

Hi developers, We just released 1.5a1. It includes much of improvements. I believe it will help you. Please let me us if you got errors with your docs. Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from

Re: [sphinx-users] Sphinx-1.5a1 has been released

Hi Paolo, Please refer CHANGES file. You can see it here: https://github.com/sphinx-doc/sphinx/blob/1.5a1/CHANGES Thanks, Takeshi KOMIYA 2016年9月21日水曜日 15時53分03秒 UTC+9 Paolo Cavallini: > > Il 21/09/2016 05:42, Komiya Takeshi ha scritto: > > Hi developers, > > > >

[sphinx-users] Re: Excluding particular base classes from autodoc inherited-members

Hi Jake, As far as I know, there are no option to do that. Thanks, 2016年9月16日金曜日 0時41分01秒 UTC+9 Jake: > > Hi all, > I hope to use autodoc for a project I'm working on. Most of my classes > inherit from some very low-level base classes, whose methods I don't want > in the documentation. > > Unf

[sphinx-users] Re: Numbered start/offset for multiple toctrees?

y like to keep > the "parts" and not have to remove them. > > Thanks again, > Mike > > > On Tuesday, September 6, 2016 at 9:26:52 PM UTC-7, Komiya Takeshi wrote: > -- You received this message because you are subscribed to the Google Groups "sphinx-use

[sphinx-users] Re: formatting rst file

Hi, It seems a bug of alabaster theme. It looks fine with classic theme. Could you file it to their project? Thanks, Takeshi KOMIYA 2016年9月28日水曜日 6時23分13秒 UTC+9 Luka Rahne: > > > I am trying to create nested and well formatted rst file like this: > > > > .. function:: level1 > > .. c

[sphinx-users] Re: formatting rst file

Ah, sorry. It was already reported as https://github.com/bitprophet/alabaster/issues/32 . 2016年9月28日水曜日 11時34分24秒 UTC+9 Komiya Takeshi: > > Hi, > > It seems a bug of alabaster theme. It looks fine with classic theme. > Could you file it to their project? > > Thanks, > Ta

[sphinx-users] Re: Numbered start/offset for multiple toctrees?

Hi, Thank you for proposal. Of course we always welcome your PR! But, personally, I can't determine that is common feature or not. So I need some advices or votes from other people. BTW, we have some issues about toctree (preface, appendix and so on). So we have to improve toctree feature. So w

[sphinx-users] Sphinx-1.4.7 released

Hi all, I'm delighted to announce the release of Sphinx 1.4.7, now available on the Python package index at . It includes about 16 bug fixes for the 1.4.6 release series. For the full changelog, go to < http://www.sphinx-doc.org/en/stable/changes.html>. Thanks

Re: [sphinx-users] Sphinx-1.4.7 released

st to verify: the latest stable release is now 1.4.8 correct? > (sphinx-doc.org states the current version is 1.4.9 which I believe is > an error) > > -jeff > > > > On 2016-10-01 11:05 AM, Komiya Takeshi wrote: > > Hi all, > > > > I'm delighte

[sphinx-users] Re: Customizing Relbar (both top/bottom) Links

Hi, It seems cloud_sptheme uses relbar() marcro to generate relbar. So you might be able to remote the hyperlink to genindex.html by overriding it. But, more simply way, you can disable to generate genindex using "html_use_index = False". Then the hyperlink will be removed automatically. Thanks

[sphinx-users] Re: PDF version shows one huge chapter? Table of contents issues with latexpdf

> Can you give an example of how to use the orphan metadata tag? > Here: :orphan: Title of document == blah blah blah... > >- Where do I put the tag, in the file that is causing the build >warning or in the TOC file? > > The top of each files which are not listed

[sphinx-users] Re: Sphinx-1.5a1 has been released

Hi, Originally, TocTree class is defined at sphinx.directives.other. so it is not moved. It is only imported at sphinx.directives. At 1.5a1, the imports are removed once. But I recovered it at current HEAD. Please wait 1.5a2. Thank you for reporting. Takeshi KOMIYA 2016年10月7日金曜日 9時24分39秒 UTC+9

[sphinx-users] Re: PDF version shows one huge chapter? Table of contents issues with latexpdf

Bg/t7DTOBb7DX0Qfxq1iXewowx5A5Yut056QCLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.05.30%2BPM.png> > > > On Wednesday, October 12, 2016 at 1:20:29 PM UTC-4, Komiya Takeshi wrote: >> >> >> Can you give an example of how to use the orphan metadata tag? >>&g

[sphinx-users] Re: Table of Contents bar on the left is not correct.

Hi, I think globaltoc helps you. Please add following settings to your conf.py: html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], } In detail, please see the document: http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars Tha

[sphinx-users] Re: Is there any way to automatically add section titles to the genindex?

the source code of Sphinx, especially around index manager. Thanks, Takeshi KOMIYA 2016年10月11日火曜日 18時40分37秒 UTC+9 Minkai Li: > > if I want to do it ，what is the extension could I do？ > > 在 2016年8月27日星期六 UTC+8下午10:28:48，Komiya Takeshi写道： >> >> Hi, >> >> To my k

[sphinx-users] Re: Text doesn't fit in simple table column - Latex-PDF export

Hi, That might come from the behavior of LaTeX engine. As a adhoc way, you can give a hint to LaTeX engine with following notation: .. tabularcolumns:: |p{1.0cm}|p{1.0cm}|L| = === Tag Required Description = ==

[sphinx-users] Re: Text doesn't fit in simple table column - Latex-PDF export

Note: I filed this as following issues: https://github.com/sphinx-doc/sphinx/issues/3042 https://github.com/sphinx-doc/sphinx/issues/3043 2016年10月13日木曜日 11時47分19秒 UTC+9 Komiya Takeshi: > > Hi, > > That might come from the behavior of LaTeX engine. > As a adhoc way, you can give

[sphinx-users] Sphinx-1.5a2 has been released

Hi all, We just released 1.5a1. It includes much of improvements. I believe it will help you. Please let me us if you got errors with your docs. Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this gr

[sphinx-users] Re: how do I add revision history table?

Hi, You can override the LaTeX macros in your conf.py: latx_elements = { 'preamble': """ \renewcommand{\maketitle}{% ... } """ } Anyway, you have to learn about LaTeX macros to customize LaTeX output. Thanks, Takeshi KOMIYA 2016年10月20日木曜日 8時03分01秒 UTC+9 E. Kelly: > > I'm having a similar pr

[sphinx-users] Re: ReadTheDocs colour customization

Hi, AFAIK, there are no options to modify colors: https://github.com/snide/sphinx_rtd_theme#configuration So additional CSS is needed to customize them. Thanks, Takeshi KOMIYA 2016年10月20日木曜日 8時02分52秒 UTC+9 Paolo Cavallini: > > Hi all, > I'm testing the RTD theme, and I'm finding it functional.

[sphinx-users] Re: :guilabel: is italic in PDF but bold in HTML

Hi, At Sphinx-1.4, Sphinx uses \sphinxmenuselection macro to represent guilabel and menuselection items. So you can override the macro to customize its style. What version do you use? BTW, the style difference between HTML and LaTeX is not good, indeed. Please file the problem to our tracker? T

[sphinx-users] Sphinx-1.5b1 has been released

Hi all, We just released 1.5b1. It includes much of improvements. I believe it will help you. Please let me us if you got errors with your docs. Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this gr

[sphinx-users] Sphinx-1.4.9 has been released

Hi all, I'm delighted to announce the release of Sphinx 1.4.9, now available on the Python package index at . It includes about 11 bug fixes for the 1.4.8 release series. For the full changelog, go to < http://www.sphinx-doc.org/en/stable/changes.html>. Thanks

Re: [sphinx-users] Sphinx-1.4.9 has been released

t only on read the docs? or it is going on? > thanks. > > -- > gilberto dos santos alves > +55(11)9-8646-5049 > sao paulo - sp - brasil > > > > > > 2016-11-23 12:45 GMT-02:00 Komiya Takeshi > >: > >> Hi all, >> >> I'm delighted to anno

Re: [sphinx-users] Call for translation updates

Hi gilberto, Sorry for late response. Now what we want to translate at this moment is the "Sphinx" project on transifex instead sphinx-doc-1.x. https://www.transifex.com/sphinx-doc/sphinx-1/dashboard/ It is used for the messages of Sphinx itself (for example, online help, warning messages and

Re: [sphinx-users] Call for translation updates

In addition, now we uses only en, es and ja for sphinx-doc. We will add your language if you had translated the reference of Sphinx. Now other languages are not translated yet. 2016年11月24日木曜日 23時06分45秒 UTC+9 Komiya Takeshi: > > Hi gilberto, > > Sorry for late response. > > N

Re: [sphinx-users] Call for translation updates

Oh, sorry. Portuguese (Brazil) (pt_BR) 100% Now pt_BR is already translated completely! Nothing is needed at this time. Thanks, 2016年11月24日木曜日 23時33分52秒 UTC+9 gsavix: > > please point url of file(s) that need asap transl. pr br . tjs > > Em 24/11/2016 12:30, "Komiya Takes

[sphinx-users] Re: "chunk after expression" build error?

Hi, "chunk after expression" means syntax error. The directive raises error if there are no empty line after `only` directive. So it will be resolved. Please try it. Thanks, Takeshi KOMIYA 2016年12月1日木曜日 8時46分24秒 UTC+9 E. Kelly: > > > I recently started getting this build message: > > WARNING:

[sphinx-users] Re: Search bar shows the RST instead of HTML page

Hi, The `html_copy_source` will help you. http://www.sphinx-doc.org/en/1.4.9/config.html#confval-html_copy_source Thanks, Takeshi KOMIYA 2016年12月2日金曜日 7時33分41秒 UTC+9 E. Kelly: > > Two new comments - > > 1) I found another workaround, from the Sphinx GitHub site ( > http://github.com/sphinx-doc

[sphinx-users] Sphinx-1.5.1 has been released

Hi all, I'm delighted to announce the release of Sphinx 1.5.1, now available on the Python package index at . It includes about 1 new feature and 11 bug fixes for the 1.5 release series. For the full changelog, go to < http://www.sphinx-doc.org/en/stable/chang

Re: [sphinx-users] Actual, working example of latex-pdf cover page?

Hi, At preamble part, The "@" sign is not expanded. Please use \makeatletter before that like following: 'preamble': r''' \makeatletter \renewcommand{\maketitle}{ \begin{titlepage} \noindent \Huge \@date \par \end{titlepage} } \makeatother

[sphinx-users] Re: var vs cvar vs ivar... What's the diff?

Hi, Unfortunately, there is no difference in these variables. I don't know the background of them. Anyway, I added the note to describe that. Thanks, Takeshi KOMIYA 2016年12月9日金曜日 15時50分32秒 UTC+9 Russell Weber: > > I noticed that there are several ways to document variables. > ivar > cvar > and j

Re: [sphinx-users] Problem with initial setup.. linkcheck and urllib3 issue.

Hi, The problem was filed as https://github.com/sphinx-doc/sphinx/issues/3295 . But, unfortunately I can't reproduce the bug at my local. Finally, I made a patch from article of stackoverflow. But I can't confirm it works fine or not. So it would be nice if you try my patch to fix it. Thanks, T

  1   2   3   4   5   6   >