Re: [sphinx-users] Paragraphs around items in a list?

I don't know why docutils determined this approach. But they surely chose this way on moving to HTML5. Please post a comment to the docutils project if you really want to change this. At present, sphinx simply follows the docutils' behavior. 2020年8月9日(日) 0:32 Yves Chevallier : > > Yes I am

Re: [sphinx-users] Paragraphs around items in a list?

Please try this on your local. We can see tag on "html5_polyglot" writer. ``` >>> from docutils import core >>> print(core.publish_parts(''' ... - a ... - b ... - c ... ''', writer_name='html5_polyglot')['html_body']) a b c >>> ``` 2020年8月8日(土) 23:46 Yves Chevallier : > > Not really sure

Re: [sphinx-users] Paragraphs around items in a list?

Hi, This is default behavior of docutils' reST parser. It always generates paragraph node. >By default docutils removes these ``: Please try again with html5 writer. It seems you're using old HTML4 writer. It suppresses tag on generating HTML. But HTML5 writer does not do that. Thanks,

[sphinx-users] ANN: Sphinx-3.2.0 is out

Hi all, Today, I released Sphinx-3.2.0. It contains many improvements and bug fixes. For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.2.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to

Re: [sphinx-users] .pylintrc?

Hi, We've used flake8 and mypy as code-checkers. Thanks, Takeshi KOMIYA 2020年8月8日(土) 5:29 Yves Chevallier : > > I am developing an extension for Sphinx and I am using the same conventions, > such as not using PascalCase for `nodes`. > > I am developing using `pylint` and I have a lot of

Re: [sphinx-users] Clean up created HTML from bad file structure

Hi, You can clean them up with `make clean` command. And let's build your document again with `make html` command after that. Thanks, Takeshi KOMIYA 2020年8月4日(火) 2:53 nclough : > > I'll start off saying my apologies for the lack of knowledge, I am new to > sphinx-doc. > > I have some

Re: [sphinx-users] Multiple extensions that extends a translator ?

Hi, Unfortunately, we can't use two translators at the same time. Only one translator can be registered to the specific builder. So it would be better to integrate these translators to a single one. As a workaround, you can override the method of the default LaTeXTranslator via assigning

Re: [sphinx-users] Reorder the list of docnames

Hi I think this tutorial helps you. This describes how to handle an event in your extension. https://www.sphinx-doc.org/en/master/development/tutorials/todo.html BTW, what is a goal of reordering? Actually, you can sort the docnames. But, AFAIK, the order of docnames is not important. The

Re: [sphinx-users] Add more details to sphinx-generated API reference

extension? > > On Monday, 3 August 2020 14:55:32 UTC+1, Komiya Takeshi wrote: >> >> It seems this pages uses autosummary extension. If so, there no way to >> add table columns for autosummary-table. >> You need to make a your own custom directive. >> >> Thanks, >&

Re: [sphinx-users] Add more details to sphinx-generated API reference

It seems this pages uses autosummary extension. If so, there no way to add table columns for autosummary-table. You need to make a your own custom directive. Thanks, Takeshi KOMIYA 2020年8月3日(月) 19:26 Markus Löning : > > Hi all, > > Currently, when we generate our API reference we basically get a

Re: [sphinx-users] Tech writer at work blog (blog.documatt.com)'s kindly ask to be listed on Projects using Sphinx page

Hi Matt, Could you send a pull request, please? Then I'll merge it to our site. Thanks, Takeshi KOMIYA 2020年7月15日(水) 17:01 Matt from Documatt : > > Hello, dear sphinx-users! > I would like to help with promoting my blog about called Tech writer at work > - at blog.documatt.com. I started it a

Re: [sphinx-users] How can one create a Sphinx directive that creates documentation from an externally defined data structure?

Hi, AFAIK, there are no way to expand the contents for directives via own custom directive. As a similar way, you can generate whole of directive via own custom directive: .. custom_set_of_attributes_directive:: Model x model_schema Which would be equivalent to: .. autoclass:: Model ..

[sphinx-users] ANN: Sphinx-3.1.2 is out

Hi all, Today, I released Sphinx-3.1.2. It contains some bug fixes (mainly autodoc and CSS troubles). For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.1.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA -- You received this message because you

Re: [sphinx-users] Sphinx autodoc - Trim module name option

Hi, Good challenge. It seems your patch is good enough. >I suspect the additional package is safer but I started out by trying to >understand where the module name is getting created in autodoc, and haven't >figured out how to access the module name from nodes yet. Pointers welcome. The

[sphinx-users] ANN: Sphinx-3.1.1 is out

Hi all, Today, I released Sphinx-3.1.1. It contains some bug fixes. For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.1.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to the Google Groups

Re: [sphinx-users] Re: I want to help to translate in french, but I can't

d >> the wrong project -- sphinx-doc. The only things I can find to translate >> are the documents themselves, not the code modules. >> >> >> I'm going to see if there's another project I should join. >> >> >> >> On Thursday, June 4, 20

Re: [sphinx-users] Warning message after sphinx upgrade

Hi, Since python3, \u has been considered as unicode-escape sequence. So you need to escape it like '\\usepackage'. >'preamble': '\usepackage{kotex}', FYI: The raw string also helps you (ex. r'\usepackage{kotex}' ). Thanks, Takeshi KOMIYA 2020年6月5日(金) 17:12 Jalba sung : > > Hi, > > I've

Re: [sphinx-users] Change name of method for documentation

call__ method. If yes, copy the > docstring from forward and use it. > > Am Donnerstag, 4. Juni 2020 15:48:15 UTC+2 schrieb Komiya Takeshi: >> >> Hi, >> >> The autodoc extension scans the target module and generates >> documentation. No way to im

Re: [sphinx-users] Numref strange behaviour

sday, 3 June 2020 17:21:34 UTC+2, Komiya Takeshi wrote: > Hi, > > At present, Sphinx assigns numbers to code-blocks having a caption. So > this is intended behavior. > > >If true, figures, tables and code-blocks are automatically numbered if they > >have a capt

Re: [sphinx-users] Change name of method for documentation

Hi, The autodoc extension scans the target module and generates documentation. No way to imitate it. As a workaround, you can insert your content manually: .. autoclass:: yourmodule.MyClass .. py:method:: __call__ Prints the input. This text is added to the document.

Re: [sphinx-users] Re: I want to help to translate in french, but I can't

Hi Adam, Now Kujiu finished translation for French. Could you update transifex by this, please? https://github.com/sphinx-doc/sphinx/pull/7783 Thank you for your help. Thanks, Takeshi KOMIYA 2020年5月28日(木) 16:01 Adam L : > > If you want to/can look at this file: >

Re: [sphinx-users] Numref strange behaviour

Hi, At present, Sphinx assigns numbers to code-blocks having a caption. So this is intended behavior. >If true, figures, tables and code-blocks are automatically numbered if they >have a caption. The numref role is enabled. Obeyed so far only by HTML and >LaTeX builders. Default is False.

Re: [sphinx-users] Custom latex commands for HTML output

Yes, Sphinx uses mathjax by default now. 2020年6月3日(水) 22:33 'CaptFugu' via sphinx-users : > > That is to bad. Is mathjax the default math renderer for HTML output? > > Am Mittwoch, 3. Juni 2020 15:17:53 UTC+2 schrieb Komiya Takeshi: >> >> There are no proper way

Re: [sphinx-users] Skip doctests included with autodoc

Hi, Unfortunately, there are no such options. I think it is hard to distinguish code blocks in reST or docstring. Thanks, Takeshi KOMIYA 2020年6月3日(水) 17:10 'Jens Jørgen Mortensen' via sphinx-users : > > Hi! > > I'm using the sphinx.ext.doctest extension to test code examples in my > docs. I'm

Re: [sphinx-users] Custom latex commands for HTML output

There are no proper way to do that. But I guess `mathjax_display` will help you to insert custom command before each display equation as a workaround: ``` # in conf.py mathjax_display = [r'\[\newcommand{\myCustomCmd}{}', r'\]'] ``` Thanks, Takeshi KOMIYA 2020年6月3日(水) 21:05 'CaptFugu' via

Re: [sphinx-users] Re: Korean Font not showing up correctly

You're welcome :-) >One issue now is with the translated version of pdf file some table header >text is not >warping and extending over to the next column. >Any pointers on how to solve this? Sorry, I don't know. It might be resolved in latest version of Sphinx. How about update it? If not

Re: [sphinx-users] Re: Korean Font not showing up correctly

Could you paste the log before the LaTeX Error? I guess LaTeX output the reason of the error. I noticed your configuration is incorrect. You must use curly braces to the usepackage `\usepackage{kotex}`. >'preamble': '\usepackage(kotex)', >Do I need to fix the babel warning? if so how do I do

Re: [sphinx-users] Re: Korean Font not showing up correctly

>How do I specify language='ko' when I execute 'make latexpdf'? You can switch language via `language` setting in conf.py. If you need to set it temporarily, `-D` option of sphinx-build is useful: `-D language=ko`. The option is passed via `SPHINXOPTS` variable. So `make latexpdf SPHINXOPTS="-D

Re: [sphinx-users] Re: Korean Font not showing up correctly

It seems you're using rst2pdf extension to build PDF file: >processing rst2pdf... So the configurations for LaTeX that you pasted is not used. Please call `make latexpdf` instead to invoke LaTeX build. (I've never build Korean document so far. So I don't know it goes well.) Thanks, Takeshi

Re: [sphinx-users] Automatic list of figures and tables

Hi, Unfortunately, Sphinx does not provide such a feature officially. I don't know there is a 3rd party extension for such purpose. If none, you need to write a Sphinx extension to do that. Thanks, Takeshi KOMIYA 2020年5月28日(木) 15:45 Adam L : > > I've seen several questions dating back years

Re: [sphinx-users] rst2pdf and python3

Sorry, I don't know. I'm not a user of rst2pdf. So I've never installed it... 2020年5月27日(水) 23:20 Beat Gurtner : > > Hi, > > and how can I install fc-match on a mac env.? > > > > On Wednesday, May 27, 2020 at 4:16:41 PM UTC+2, Komiya Takeshi wrote: >> >>

Re: [sphinx-users] rst2pdf and python3

It seems rst2pdf invokes `fc-match` command. But it is not installed in your environment. Please install it and try again. >FileNotFoundError: [Errno 2] No such file or directory: 'fc-match' Thanks, Takeshi KOMIYA 2020年5月27日(水) 19:00 Beat Gurtner : > > Hi, > > I try to run rst2pdf with

[sphinx-users] ANN: Sphinx-3.0.4 is out

Hi all, Today, I released Sphinx-3.0.4. It contains some bug fixes. For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.0.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA -- You received this message because you are subscribed to the Google Groups

Re: [sphinx-users] Custom template for index.html

Hi, Unfortunately, there is no proper way to switch HTML templates only for a specific page. In Sphinx doc, we use `html_additional_pages` to copy static index.html, and change master_doc to "contents.rst" not to conflict with static file. Thanks, Takeshi KOMIYA 2020年5月21日(木) 23:58 Ken : > >

Re: [sphinx-users] Event "-M" must be of the form "123" when doing make html

Hi, I haven't seen the message from Sphinx. I guess it comes from your script loaded by autodoc or conf.py. If your script are going to something like argument parsing, please make sure your main routine is protected by if __name__ == '__main__' condition. Thanks, Takeshi KOMIYA 2020年5月19日(火)

Re: [sphinx-users] How to set local TOC level?

Hi, It seems no way to control it... Thanks, Takeshi KOMIYA 2020年5月14日(木) 16:05 Magic X : > > Hi, > > I'm going to use the 'toc' variable in a html template to produce local TOC > for the current document in the sidebar, is it possible to control the TOC > max depth? > > -- > You received

Re: [sphinx-users] customizing the class template

Hi, To customize output of autosummary, using own custom template is a good idea. But it is hard to replace __init__ method description by __call__ method even if you're using template. I don't have idea to realize it... Note: To create a custom template: 1. Create a directory named autosummary

Re: [sphinx-users] Announcing releases here

Hi jeff, Okay, I'll do that from the next release. Thanks, Takeshi KOMIYA 2020年5月9日(土) 0:18 Jeff McKenna : > > Hi KOMIYA-san, > > Would you mind sending a quick note here for each release? (point releases > also) I think it would be great to be notified here of each release, such as > 3.0.4

Re: [sphinx-users] How to render two or more consecutive backslashes?

Hi Matt, It must be a bug. Could you file a bug report to GitHub please? Then I'll investigate it soon. Thanks, Takeshi KOMIYA 2020年4月29日(水) 21:21 Matt from Documatt : > Hello all, > I have RST escaping question. Escape char is \. If you want to backslash > in output, I write \\ in RST. That's

Re: [sphinx-users] Is there a way to force downloads

s on local HTML browsing. If so, please upload your document to server and try it again. Thanks, Takeshi KOMIYA 2020年4月25日(土) 2:08 Žygimantas Šalkus : > > I am using v3, the latest stable which I got from pip. > > On Fri, Apr 24, 2020, 19:24 Komiya Takeshi wrote: >> >> H

Re: [sphinx-users] Is there a way to force downloads

Hi, What version of Sphinx do you use? The latest Sphinx uses `download` attribute to the download link in HTML5 output. So modern browsers will start downloading the target file. Thanks, Takeshi KOMIYA 2020年4月24日(金) 23:45 Žygimantas Šalkus : > > Hello, I have an issue with :download: role.

Re: [sphinx-users] Are there any serious C++ projects that use Sphinx alone?

y I was doing that). > This is why finding some examples using the cpp domain would be nice -- > although I realize this error is just pure rST neophytism (and not posting > the complete code initially). > > > > > On Sunday, 19 April 2020 01:25:30 UTC-4, Komiya Take

Re: [sphinx-users] Are there any serious C++ projects that use Sphinx alone?

Hi, On my local, it works fine without error. I copied your "cpp:function" definition to my index.rst and build it to HTML with Sphinx-3.0.1. And the function is not filed into index. Please check your version of Sphinx and try it again with minimal example. Thanks, Takeshi KOMIYA 2020年4月19日(日)

Re: [sphinx-users] Adjusting the search results page: Links to headings under which results appear?

>Is it possible to adjust the search results page so that not only the file >names are listed, but also headings under which the results appear within >these files? Are these results are "file names"? It seems they are entrypoints of APIs. I guess they are similar to the result of python-docs.

Re: [sphinx-users] Broken autosummary links

Hi, I think you need to use `:toctree:` option to generate contents from docstring automatically. But it is a bit complex usage. So please read the document of autosummary. Thanks, Takeshi KOMIYA 2020年4月14日(火) 18:03 F H : > > Hi, > > I am documenting some Python code with autodoc and

Re: [sphinx-users] operation of the sphinx documentation pages

idea. But I'm okay if some pages (or some >> paragraphs?) are translated. > > > I think so too. I think 50% translation of intro is a good standard. How do > you think? > > BR Tetsuo Koyama > > 2020年4月5日日曜日 0時31分47秒 UTC+9 Komiya Takeshi: >> >> Hi Tetsuo

Re: [sphinx-users] Spurious "see" before links in generated texinfo

Hi Thomas, I suppose it might be a bug. Could you make a minimal reproducible example? I'd like to reproduce it on my local. Thanks, Takeshi KOMIYA 2020年4月6日(月) 1:13 B Thomas : > > Hi, > > I built Python texinfo documentation using the command line > > sphinx-build -b texinfo python_src/Doc

Re: [sphinx-users] sphinx-build always reads and writes outoput for *all* files, updated or not

Hi, >updating environment: [config changed ('source_parsers')] 504 added, 1 >changed, 0 removed Could you let me know your `source_parsers` configuration in conf.py please? Note: In latest recommonmark, the source parser is configured automatically. So you don't need to configure it on your

Re: [sphinx-users] Include project in list of projects using Sphinx

Hi Valeria, Thank you for letting me know. Could you send a pull request to us if possible? Then I'll merge it soon. Thanks, Takeshi KOMIYA 2020年4月7日(火) 7:12 Valeria Barra : > > Hi, > > I was wondering if you could please include libCEED in the list of projects > using Sphinx for their

Re: [sphinx-users] Implementing custom "autodoc" style objects

Hi, Autodoc is one of complex extension in Sphinx, I think. It is hard to understand how it implemented. It adopted two-layered model. The first layer; python domain describes python object in reST level. It provides many directives for that purpose; `py:function`, `py:class`, `py:method` and so

Re: [sphinx-users] Re: Getting NotImplementedError: Unknown node: compact_paragraph

o, is there any way to update > that version for a project? > > Thanks, > Juan P. Dominguez-Morales > > > > El jueves, 2 de abril de 2020, 18:54:47 (UTC+2), Komiya Takeshi escribió: >> >> Hi Juan, >> >> Please upgrade your Sphinx to latest one. >&g

Re: [sphinx-users] operation of the sphinx documentation pages

Hi Tetsuo, Thank you for your proposal. IMO, almost not translated language is better not to be published. I guess the user who switches the language expects the document is translated (a little). But almost not translated document makes them disappointed. On the other hand, it must be

Re: [sphinx-users] Company support: Sponsoring Sphinx?

Hi, Thank you for your proposal. But I don't have a plan to start sponsorship. To precise, I don't have a knowledge to manage sponsorship for OSS products. Only we have to pay is a fee of domain (sphinx-doc.org) because many online services provides a free plan for OSS (Thanksfully!). So no good

Re: [sphinx-users] Re: Getting NotImplementedError: Unknown node: compact_paragraph

Hi Juan, Please upgrade your Sphinx to latest one. It seems your problem is resolved. Thanks, Takeshi KOMIYA 2020年4月2日(木) 3:41 Juan Pedro Domínguez : > > Update: It only happends when building the PDF version. If I remove the > "Build PDF" tick on the settings, it is built successfuly. > > >

[sphinx-users] Sphinx-3.0.0b1 released.

Hi all, We just released Sphinx-3.0.0b1. It has many changes including incompatible ones. Please confirm it working fine on your documents. In detail, please see CHANGES: https://github.com/sphinx-doc/sphinx/blob/3.0.x/CHANGES You can use it with: pip install --pre Sphinx Since this is a beta

Re: [sphinx-users] Autodoc: Dealing with __init__ modules

Hi Ferdinand, How did you use automodule directive? Please remove "__init__" from its argument if you gave module name containing __init__ like "some_package.__init__". automodule takes a module name as your python script does. So no __init__ is needed for its argument. If not, please let me

[sphinx-users] Call for translation updates

Hi all, On the 3.0 release, we have added some messages to Sphinx. So we need your help to translate them as possible. If you can translate messages, please join our project on transifex: https://www.transifex.com/projects/p/sphinx-1/ It's very easy -- signup, request addition to a language

Re: [sphinx-users] One author per line in latex output?

Hi, How about using `latex_document`? It accepts LaTeX macros for authors. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-latex_documents Thanks, Takeshi KOMIYA 2020年3月2日(月) 23:58 Angel de Vicente : > > Hi, > > I would like to give in author variable (conf.py) a list of

Re: [sphinx-users] embed javascript in html?

Hi, You can embed JavaScript into HTML files directly using `Sphinx.add_js_file()` API. https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_js_file Thanks, Takeshi KOMIYA 2020年3月3日(火) 10:20 Nadia Pranabudi : > > Hi! > > Rather than creating external javascript

Re: [sphinx-users] Child Class __init__ Inherit Arguments of Parent Class __init__

Hi, autodoc does not support such feature. It is difficult to guess "*args" equals to "parent_argument". I'm welcome if you have good idea to realize it. contributions are always welcome :-) Thanks, Takeshi KOMIYA 2020年3月4日(水) 3:25 Connor McClellan : > I have been trying to use Sphinx-autodoc

Re: [sphinx-users] Substitution with math

Hi, It seems an invalid space found before "::". Could you remove it please? Thanks, Takeshi KOMIYA 2020年3月4日(水) 23:14 RdB : > > Hello, > > I did not find documentation on how to do substitutions with math role. How > can I achieve it? > > If I do > > .. |normal| replace :: :math:`\hat{n}` > >

Re: [sphinx-users] Re: Problem in firefox when loading different pages

Hi, Could you let us know a URL of the page? Or please make a minimal example. It is difficult to help you without reproducing the problem. Thanks, Takeshi KOMIYA 2020年2月27日(木) 21:41 Benoit Leybaert : > I want to add, after searching more, that this is probably caused by a > custom css sheet.

Re: [sphinx-users] namedtuple autosummary complains about index() and count() methods

Hi, It seems your module sparse.greedy_pursuit expects to use autosummary for documentation. So I guess you need to use autosummary instead of autodoc. Could you ask the author of modules about a proper way to generate documentation? Thanks, Takeshi KOMIYA 2020年2月23日(日) 2:40 Danylo Ulianych : >

Re: [sphinx-users] Intersphinx: referencing typing.X

Hi, Good point. Indeed, Sphinx expects given type in :param: info-field-list is a kind of classes. So it would not work for :py:data: objects. Could you file an issue to GitHub please? I'll consider the good way to support them. Thanks, Takeshi KOMIYA 2020年2月29日(土) 6:32 Zaur Nasibov : > > Dear

Re: [sphinx-users] Member order

Oh, I'd forgotten it. But, yes, I meant it. 2020年2月25日(火) 1:00 'Mmanu Chaturvedi' via sphinx-users : > > Hi Takeshi Komiya, > > Thanks! This must be the issue, right? > https://github.com/sphinx-doc/sphinx/issues/5270 > > -- > You received this message because you are subscribed to the Google

Re: [sphinx-users] how to translate strings in conf.py?

Hi, Hmm... it's difficult question. At this moment, there are no support from Sphinx. So you need to switch messages inside conf.py by yourself: ``` if language == 'ja': copyright = ... elif language == 'de': copyright = ... else: copyright = ... ``` Thanks, Takeshi KOMIYA

Re: [sphinx-users] Member order

issues related to `bysource`: > https://github.com/sphinx-doc/sphinx/issues/3673 > > Thank you, > Mmanu > > On Sunday, February 9, 2020 at 8:31:24 AM UTC-5, Komiya Takeshi wrote: >> >> Hi, >> >> Is this resolved if we'll add an option for sorting methods by

Re: [sphinx-users] automatically, the address is replaced with 'html#id1' like this.

Hi, Sphinx and docutils (reStructuredText library) generate element ID automatically. So it is difficult to control them from markups. Usually, these tools uses section titles to generate element IDs. But they except all element IDs should start with alphabets, not numbers. Thanks, Takeshi

Re: [sphinx-users] Member order

Hi, Is this resolved if we'll add an option for sorting methods by definition order (in source code)? We have an issue to add such option. I'd like to know it helps your case or not. Thanks, Takeshi KOMIYA 2020年2月6日(木) 13:58 'Mmanu Chaturvedi' via sphinx-users : > > Hi, > > Consider the

[sphinx-users] Sphinx-2.4.0 released.

Hi all, I'm delighted to announce the release of Sphinx 2.4.0 final, now available on the Python package index at . It includes about 18 new features and 23 bug fixes. Especially, autodoc is much improved in this release. I wrote an article to explain the

Re: [sphinx-users] passing arguments to mklatex without using makefile

Hi, Thank you for posting. Sadly, there no such options now. But I posted a PR for this feature. https://github.com/sphinx-doc/sphinx/pull/7116 Thanks, Takeshi KOMIYA 2020年2月8日(土) 22:02 Robert Cohn : > > I want to pass arguments like -silent to latexmk. It works fine when I use > the standard

Re: [sphinx-users] numref for container

436, > in set_name_id_map > self.set_duplicate_name_id(node, id, name, msgnode, explicit) > File "/home/user/Documents/docutils/docutils/docutils/nodes.py", line 1475, > in set_duplicate_name_id > dupname(node, name) > File "/home/user/Documents/docutil

Re: [sphinx-users] numref for container

) 8:37 Myne : > > Hi, > > I tried to make an extension which will number and reference the containers > but did not succeed. > https://github.com/jtrakk/sphinx-demo > > How can I fix it? > > Thanks. > > On Saturday, February 1, 2020 at 3:22:52 AM UTC-8, Komiya Ta

Re: [sphinx-users] numref for container

Hi, "numref" only does referring by number as it named. To refer something by number, you need to assign numbers to each object before referencing. But Sphinx does not have a feature to assign numbers to containers. So you need to write some extensions to do that. Personally, I can't imagine how

Re: [sphinx-users] Re: Container for both body and structural elements (sections)

It's one of standard reST directives. Please refer the reference of reST in details: https://docutils.sourceforge.io/docs/ref/rst/directives.html#container 2020年2月1日(土) 12:37 Myne : > > Were you able to find a directive like this? I would be interested to use it > as well. > > On Wednesday,

Re: [sphinx-users] recommended design style for Sphinx extensions that generate documentation?

, 29 January 2020 17:11:50 UTC, Komiya Takeshi wrote: >> >> I think both approach is okay. But, as you experienced, second >> approach requires you a knowledge of target document tree. And, it is >> not documented well unfortunately. I've usually read source code of >>

Re: [sphinx-users] recommended design style for Sphinx extensions that generate documentation?

Hi Peter, I think both approach is okay. But, as you experienced, second approach requires you a knowledge of target document tree. And, it is not documented well unfortunately. I've usually read source code of directives, roles, Sphinx itself and other components to know its structure of

Re: [sphinx-users] sphinx Lightbox extension and Markdown

Hi, It seems sphinxcontrib-images extends "image" directive of Sphinx. But recommonmark does not use and embed images directly to document-tree. So it would not work. I don't have idea they work together... Thanks, Takeshi KOMIYA 2020年1月28日(火) 6:36 StefanK : > > Hi, > > working on a

Re: [sphinx-users] Filtering search results

Hi Andy, Could you try it with latest Sphinx release please? If still happened, it's a bug of Sphinx. So please file an issue to GitHub. I'll work for it. Thanks, Takeshi KOMIYA 2020年1月28日(火) 22:02 Andy Cheesman : > > Hi People > > Is it possible to filter the search results of the sphinx

Re: [sphinx-users] auto-numbered table of contents

Hi, At prensent, autodoc does not support to generate TOC entry. So you need to write section headers to each modules and functions manually. We have a feature request for this purpose. But there are no time to implement it. Note: https://github.com/sphinx-doc/sphinx/pull/7004 is one of

Re: [sphinx-users] Custom command line variables and rst substitution

Hi, reST parser does not refers config values. So you need to pass it to the parser. Sphinx uses a transform component to do that: https://github.com/sphinx-doc/sphinx/blob/816a06564de5cfdd23df57d1b3291c0ccc8dacda/sphinx/transforms/__init__.py#L100-L118 BTW, we have `rst_prolog` config value to

Re: [sphinx-users] Absolute path instead of relative path being used in translatable (.pot and .po) files

Hi Harmon, Indeed, that is strange. I got absolute paths with Sphinx-2.3.0 and small project on my local. What Sphinx versions do you use? What will happen with the Sphinx project just after quickstart'ed? Thanks, Takeshi KOMIYA 2020年1月12日(日) 3:14 Harmon : > > When I use > make gettext > the

Re: [sphinx-users] Skipping documentation

not sure: > https://github.com/pybind/pybind11/issues/2059 > > Cheers, > Mmanu > > On Wednesday, January 8, 2020 at 11:42:34 AM UTC-5, Komiya Takeshi wrote: >> >> Hi, >> >> By default, private members (starts with underscore), special members >> (double unde

Re: [sphinx-users] Skipping documentation

Hi, By default, private members (starts with underscore), special members (double underscored) and undocumented members are skipped. But users can change it via directive options (ex. :private-members: and :special-members:). Thanks, Takeshi KOMIYA 2020年1月8日(水) 2:00 Mmanu Chaturvedi : > > Hi, >

Re: [sphinx-users] sphinxmaketitle variable from config.py

Hi Angel, How about using latex_elements['preamble'] ? It is inserted into preamble part of the document. So you can build \sphinxmaketitle macro dynamically. https://www.sphinx-doc.org/en/master/latex.html Thanks, Takeshi KOMIYA 2020年1月7日(火) 2:57 Angel Diaz : > > I've overridden the custom

Re: [sphinx-users] Swapping source and destination language

Hi Denis, FWIW, I found `sphinx-rst-builder` extension. It might help your case. https://pypi.org/project/sphinx-rst-builder/ Thanks, Takeshi KOMIYA 2020年1月7日(火) 3:44 Denis Cardon : > > Hi everyone, > > First, thanks again for this very nice piece of software. Sphinx really > helps to write

Re: [sphinx-users] How does one avoid this weird rendering of parameters?

Hi, Thank you for reporting. It's difficult situation to Sphinx. It seems no way to avoid such output. I'd like to try to this problem. Could you file an issue please? Thanks, Takeshi KOMIYA 2019年12月11日(水) 18:17 'Vinay Sajip' via sphinx-users : > > If I have additional paragraphs in my

Re: [sphinx-users] how to control maximum displayed width for github.io

> > Thanks, > Mark > > > On Thursday, January 2, 2020 at 8:56:56 AM UTC-6, Komiya Takeshi wrote: >> >> Hi Mark, >> >> How about set html_theme_options['body_max_width']? It seems page width >> is controlled by the setting. >> https://www.sphinx-doc.

Re: [sphinx-users] Container for both body and structural elements (sections)

Hi, Unfortunately, no such directive is not provided as built-in. AFAIK, you need to write own directive for that purpose. You can do it with `match_titles=True` option for nested_parse(). Thanks, Takeshi KOMIYA 2020年1月2日(木) 2:16 Libor Jelínek : > > I'm looking at container:: directive. It does

Re: [sphinx-users] Is it possible to force inclusion of MathJax?

for that. It only described in CHANGES and its code: https://github.com/sphinx-doc/sphinx/blob/0319faf8f1503453b6ce19020819a8cf44e39f13/sphinx/domains/math.py#L80-L85 Thanks, Takeshi KOMIYA 2020年1月2日(木) 23:08 : > > Hello, > > On Thu, 2020-01-02 at 23:04 +0900, Komiya Takeshi wrote:

Re: [sphinx-users] Is it possible to force inclusion of MathJax?

Hi, mathjax will be loaded only when document contains any math elements. How about make plotly objects subclasses of math node? Then mathjax extension will recognize them as math elements. As a workaround, you can modify "has_equations" attribute of math domain. But I don't think not a good way

Re: [sphinx-users] fjson produced by JSON builder

I don't know that. But it seems it output .fjson file since its beginning. https://github.com/sphinx-doc/sphinx/commit/11498d0037#diff-9b024f3a65a9155bebddd27a7ed6de28R56-R57 Thanks, Takeshi KOMIYA 2019年12月23日(月) 0:09 Libor Jelinek : > > Why JSON files produced by JSON builder has fjson file

Re: [sphinx-users] Maya's MEL language and Sphinx?

rce2.html", "source3.html" as well. For instance, the directive might > create an output file for each procedure it discovers, rather than > accumulating them all in the current output. > > On Friday, October 11, 2019 at 11:21:59 PM UTC-3, Komiya Takeshi wrote: >&

[sphinx-users-jp] Sphinx-users メーリングリストの閉鎖と Slack への移行について

こんにちは、@tk0miya です。 コミュニティの活動の場が Twitter や Slack に移っていったこともあり、近年はこのメーリングリストへの投稿もかなり少なくなってしまいました。2018年の投稿は 1トピックのみ、2019年も(忘年会の連絡の) 1トピックのみという状況でした。 こうした状況を受け 2019年の Sphinx-users.jp 定期総会で今後の方針について議論を行ったところ、本メーリングリストは閉鎖し、活動の場を Slack に移すことに決定されました。近日、このメーリングリストへの新規ポストを停止し、アーカイブの閲覧のみ可能な状態に切り替えたいと思います。

Re: [sphinx-users] literal percent sign in literal text

Hi Bob, By default, Sphinx considers all of code-block is a python code. So it is highlighted as python code. Not to highlight them as python, please configure "highlight_language = 'none'" in your conf.py. see

[sphinx-users] I've started GitHub sponsors

Hi all, I'm tk0miya, one of maintainers of Sphinx. Recently, I've started GitHub sponsors program at https://github.com/sponsors/tk0miya . It will help my development. If you have a fun for Sphinx, please consider to become my sponsor :-) Thanks, Takeshi KOMIYA -- You received this message

[sphinx-users] FYI: A slide "Why we need to learn Inside Sphinx" in SphinxCon JP 2019

Hi all, I had a talk on SphinxCon JP 2019 in last week. My talk is titled as "Why we need to learn Inside Sphinx". I hope it will help your documentation life of Sphinx. Please read and make your own extension! Why we need to learn "Inside Sphinx"

Re: [sphinx-users] Custom variable in conf.py

Hi Andy, You can use a pair of ``tags`` object and ``-t`` option of sphinx-build command for that purpose. ``` # in conf.py if tags.has('master'): # when `-t master` given for sphinx-build ... else: # otherwise ... ``` Thanks, Takeshi KOMIYA 2019年11月22日(金) 22:55 Andy Cheesman :

Re: [sphinx-users] Toctree text not being translated

lly filed? > > L. > > > Dne úterý 27. února 2018 2:30:00 UTC+1 Komiya Takeshi napsal(a): >> >> Hi, >> >> On my local, "Contents:" are extracted into .pot file. Certainly >> others are not. At present, they are not supported. >> Please fil

Re: [sphinx-users] list of intersphinx mapping resources

AFAIK, global list of intersphinx is same as global list of Sphinx documentations. If so, we have a list for projects using sphinx: https://www.sphinx-doc.org/en/master/examples.html 2019年11月17日(日) 15:53 Luc Saffre : > > Andy, I have no suggestion. I don't see how a global list could be useful.

<    1   2   3   4   5   6   >