Re: [sphinx-users] Re: Hyperlink to autonumbered list item

Hi, You can see what happened via `make pseudoxml`. It dumps the intermediate document structure as XML. This is a part of generated XML from your snippet. ``` Item 1

[sphinx-users] Sphinx-5.0.0 is out

Hi all, I'm delighted to announce the release of Sphinx 5.0.0 final, now available on the Python package index at . It includes many changes including incompatible ones. Please confirm it working fine on your documents. In detail, please see CHANGES:

[sphinx-users] Call for translation updates

Hi all, On the 5.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

[sphinx-users] Sphinx-5.0.0b1 released

Hi all, We just released Sphinx-5.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/5.0.x/CHANGES You can use it with: pip install --pre Sphinx Since this is a beta

Re: [sphinx-users] Autodoc documents private members of inner dataclass

erally: > > .. currentmodule:: my_module > > Standard API > > > > MySection > - > > .. autosummary:: > > TopClass > > TopClass > ~ > > .. autoclass:: TopClass > :members: > > > On Wed, Mar 30, 2022 at 6:14 PM Komiy

Re: [sphinx-users] Autodoc documents private members of inner dataclass

Hi, What option do you pass to the autodoc directives? Please show an example of reST document. Thanks, Takeshi KOMIYA 2022年3月30日(水) 18:26 'Alex Botev' via sphinx-users : > > So I have something among the lines of: > > ``` > class TopClass: > @my_decorator > class InternalClass: >

Re: [sphinx-users] Custom docstring format

Hi, If you can accept writing docstring by reST, you can do it with creating a transform component that generates content from field-list items like "test-purpose", "test-environment", and so on. https://docutils.sourceforge.io/docs/ref/transforms.html Thanks, Takeshi KOMIYA 2022年3月18日(金) 19:07

Re: [sphinx-users] Marking up metasyntactic variables and the like

used role or not. So it would be better to publish it as a 3rd party extension at first. > Or actually, perhaps it could be proposed in Docutils? Sorry, I can't answer it because I'm not a maintainer of docutils. Thanks, Takeshi KOMIYA 2022年1月15日(土) 22:37 Jean Abou Samra : > > Le 15/01/20

Re: [sphinx-users] Marking up metasyntactic variables and the like

For now, Sphinx does not have such a mark-up. So you need to create an extension to realize it. # Sorry for the direct reply to you. It's not intended. Repost to the group again. Thanks, Takeshi KOMIYA 2022年1月13日(木) 7:46 Jean Abou Samra : > > Hi, > > One thing I like a lot with Sphinx is its

Re: [sphinx-users] How to avoid doctree-read exception when writing new directive extension

Hi, Sphinx expects all section nodes have their node_id. So please call `document.note_implicit_target(section_node)` inside your directive. Thanks, Takeshi KOMIYA 2022年1月7日(金) 3:00 Thomas A. Christensen II : > > Hi all, > > I'm trying to write my first Sphinx extension. It is a directive that

Re: [sphinx-users] Regression highlighting java code snippet

Hi Andrea, Happy new year! I guess new pygments would get errors internally on processing your code. Could you try passing "-F raiseonerror" option to pygmentize? Thanks, Takeshi KOMIYA 2022年1月1日(土) 19:10 Andrea Aime : > > Hi all, > I work on the GeoTools project, which has been successfully

Re: [sphinx-users] Add new Filipino language support

Hi, Please join sphinx-doc team on transifex and translate messages in Filipino. Then we'll be able to support it. https://www.transifex.com/sphinx-doc/sphinx-1/dashboard/ Thanks, Takeshi KOMIYA 2021年12月11日(土) 18:44 Lakan Haraya Dimapantayan : > > I am happy if Sphinx will also be support

Re: [sphinx-users] How to specify a link image URL header?

How about https://pypi.org/project/sphinxext-opengraph/? 2021年11月8日(月) 13:04 Luc Saffre : > > Hi all, > > when somebody shares, in a social media platform, a link to a website > generated by Sphinx, the platform analyzes the content to find out a title > and a picture for that link. Facebook

Re: [sphinx-users] Insert text depending on output file type.

Hi, How about using the "only" directive? It can output only on generating arbitrary format. https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only Thanks, Takeshi KOMIYA 2021年10月27日(水) 16:44 Jason Viloria : > > Hi, > > Is it possible to add text

Re: [sphinx-users] Unselectable code-block prompt

In python's case, the pygmentize command (CLI of pygments) recognizes ">>>" as a prompt and gives style to it. $ echo '>>> A prompt' | pygmentize -l python -f html A prompt On the other hand, in bash's case, it can't recognizes "$" as a prompt. So there is no special styles on the output. $

Re: [sphinx-users] Unselectable code-block prompt

Ah, sorry. I had to describe that. We use highlighting library pygments to detect prompts. It can parse the code-block and can recognize the kind of each token. 2021年9月14日(火) 23:22 Ron Stone : > > Thanks, but I am still missing something here. How does the system > distinguish between a prompt

Re: [sphinx-users] Unselectable code-block prompt

Hi, >Can someone please explain how this is configured and invoked? The latest Sphinx uses CSS to make prompts unselectable. refs: https://developer.mozilla.org/en-US/docs/Web/CSS/user-select Thanks, Takeshi KOMIYA 2021年9月14日(火) 18:42 Ron Stone : > > Hi, > > I originally posted this to

Re: [sphinx-users] Documentation on search facilities in sphinx

Hi, Unfortunately, there is no special document for the implementation of search feature. It's composed mainly from the two parts: 1. On building HTML document, search feature also builds search-index (indexing). 2. On search page, the searcher script (JavaScript) loads the search-index and

Re: [sphinx-users] How to set :annotation: option as default for autodata directive

Hi, There is no way to set `:annotation:` option for all autodata directives. I can't imagine what you'd like to do because I think giving the same right-hand value to all variables is meaningless to me. Could you let me your goal in detail? Thanks, Takeshi KOMIYA 2021年7月7日(水) 8:31 Jeff Lerman

Re: [sphinx-users] sphinx-build Not found in "sudo"

Hi, I guess you installed Sphinx into user space. So python could not find the sphinx-build command. Please check how you installed it. And please do "sudo pip install Sphinx==1.8.5" if you'd like to run Sphinx under sudo. FYI: Bot python2.7 and sphinx1.8 have been already deprecated. So it

Re: [sphinx-users] merging sphinxapi-doc output

Hi, > Is there a way to tell sphinx.ext.autodoc to output intermediate RST files in > order to merge them into a unified document? Unfortunately, there is no such option. autodoc generates intermediate reST documents and processes them on the fly. Thanks, Takeshi KOMIYA 2021年7月16日(金) 20:36

Re: [sphinx-users] ANN: Sphinx-4.1.0 is out

home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/registry.py", > line 433, in load_extension > err) from err > sphinx.errors.ExtensionError: Could not import extension > sphinx.builders.epub3 (exception: cannot import name > 'RemovedInSphinx40Warning') > >

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

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

Re: [sphinx-users] Sphinx 4.1 release plan

Hi, Good point. The release date of 4.1.0 was passed and should be updated. We adopted a bi-monthly release cycle. And 4.0.0 was released just 2 months ago (May 9th). So I'd like to release the stable version this weekend. Thanks, Takeshi KOMIIYA 2021年6月28日(月) 20:40 Felix Hildén : > > Hi, > >

Re: [sphinx-users] Constances in autodoc

Hi, How about using `#:` style comment for the constant? https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-automethod Thanks, Takeshi KOMIYA 2021年6月27日(日) 8:05 Louis King : > > > All, I realize in python, a constant is really just a state of mind but I > would like

Re: [sphinx-users] Link to source page (viewcode generated) from withing text

Hi, At present, there are no such features. IMO, it would be nice if somebody will improve the extension :-) Thanks, Takeshi KOMIYA 2021年6月19日(土) 1:43 Oriol Abril Pla : > > > Hi everyone, > > I use the viewcode extension to add the [source] link in API pages which is > great, but I would also

Re: [sphinx-users] reST markup error: :16: (SEVERE/4) Unexpected section title

Hmm... I don't have any idea to investigate what file is wrong. Perhaps, -v option might help you. Sorry for not helping you. Thanks, Takeshi KOMIYA 2021年6月3日(木) 0:24 anurag garg : > > Hi Takeshi, > > The make docs just calls : cd docs and make html. > > The `make html` is calling: `sphinx-build

Re: [sphinx-users] How to filter which methods are included in an autosummary list?

Hi, Unfortunately, there is no way to customize (reorder, filter, and so on) the result of autosummary. I think it's useful. So it would be nice if autosummary will support it :-) Thanks, Takeshi KOMIYA 2021年5月29日(土) 21:25 Connossor : > > Hi all, > > Is there a way to gather methods into groups

Re: [sphinx-users] Inclusion in the Projects using Sphinx list

Hi, Could you send us a pull request, please? I'll merge it soon. Thanks, Takeshi KOMIIYA 2021年5月26日(水) 5:15 Rohit Bohara : > > Hi, > > I work at asvin GmbH, Germany. We have platform to distributed firmware > updates for IoT devices. We use Sphinx read the docs theme for our technical >

Re: [sphinx-users] reST markup error: :16: (SEVERE/4) Unexpected section title

Hi, Please check what command is invoked on "make docs". Basically, Sphinx outputs a warning with its filename. So I guess this might be a warning from other tool. Thanks, Takeshi KOMYA 2021年5月27日(木) 3:42 anurag garg : > > Hi Sphinx users, I am trying to update my orgs sphinx version from 1.8.3

Re: [sphinx-users] underscore.js dependency: security warning

I think there is nothing to do on upgrading Sphinx basically. If you have time, I recommend you to read the CHANGES file to understand breaking change. Thanks, Takeshi KOMIYA 2021年5月13日(木) 3:29 Ben Hourahine : > > Great, thank you! > > Incidentally, any tips on upgrading an existing Sphinx

Re: [sphinx-users] underscore.js dependency: security warning

Hi, Thank you for letting us know. I'll upgrade it on 4.0.2 soon (will be released this weekend). Thanks, Takeshi KOMIYA 2021年5月12日(水) 22:29 Ben Hourahine : > > Hi, > Thanks for this excellent tool! > > We use it for various things in a quantum chemistry tool-chain, but have > recently

[sphinx-users] Sphinx-4.0.0 is out

Hi all, I'm delighted to announce the release of Sphinx 4.0.0 final, now available on the Python package index at . It includes many changes including incompatible ones. Please confirm it working fine on your documents. In detail, please see CHANGES:

Re: [sphinx-users] Re: Summaries of module contents at top of each module html, done automatically

There is no good way to register the classes and functions to ToC. Please generate a section for each entry as a workaround. Thanks, Takeshi KOMIYA 2021年5月2日(日) 0:22 Carl Gay : > > I'm also looking for this. Essentially I want what http://golang.org/pkg/ > has, where if you click through to one

Re: [sphinx-users] Re: intersphinx -- how does mapping find domain name?

Hi, The intersphinx basically works transparently. It automatically converts cross-references to remote references if the reference target not found locally. A reference :py:class:`zipfile.ZipFile` will be converted to a) a local reference if local document has an entry for zipfile.ZipFile, or b)

[sphinx-users] Re: Sphinx-4.0.0b1 released

release, we expect that you may encounter bugs. If you find a bug, please file an issue on Github issues: https://github.com/sphinx-doc/sphinx/issues Thanks, Takeshi KOMIYA 2021年4月12日(月) 0:40 Komiya Takeshi : > > Hi all, > > We just released Sphinx-4.0.0b1. > It has many ch

Re: [sphinx-users] Beginners Question on auto doc and scripts in the folder.

Hi, How about using sphinx-apidoc? It generates reST files from python scripts by searching directories. https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html Thanks, Takeshi KOMIYA 2021年4月24日(土) 0:45 Sambid Wasti : > > Hi all, > > I am a new user of Sphinx documentation. Most of my

[sphinx-users] Call for translation updates

Hi all, On the 4.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

[sphinx-users] Sphinx-4.0.0b1 released

Hi all, We just released Sphinx-4.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/4.0.x/CHANGES You can use it with: pip install --pre Sphinx Since this is a beta

Re: [sphinx-users] Adding images to the sidebar.

How about using `html_static_path` to copy the images? https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path Thanks, Takeshi KOMIYA 2021年4月11日(日) 15:48 Andrew Back : > > Hi Takeshi, > > On Sunday, 11 April 2021 at 04:42:27 UTC+1 i.tk...@gmail.com wrote: >> >> Hi,

Re: [sphinx-users] Adding images to the sidebar.

Hi, I think you need to learn customizing HTML templates to do that. Please read the templates in RTD theme and this document. https://www.sphinx-doc.org/en/master/templating.html Thanks, Takeshi KOMIYA 2021年4月11日(日) 5:20 Andrew Back : > > I'm using RTD theme and would like to include

Re: [sphinx-users] Ignoring certain files for search

Hi, You can specify nosearch option to the arbitrary pages using bibliographic fields: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#special-metadata-fields But there are no options to ignore files all at once. Thanks, Takeshi KOMIYA 2021年4月9日(金) 0:27 Daniel

Re: [sphinx-users] How to use longtable?

>Is it possible to either rename this label or remove it completely? There is no formal way to remove it. But you can do it by a hacky way. Please add this configuration to your conf.py: latex_elements = { 'preamble': r"""\protected\def\sphinxtablecontinued#1{}""" } Thanks, Takeshi KOMIYA

Re: [sphinx-users] Indexing static HTML files

Hi, Unfortunately, there is no way to index the external HTML files. Thanks, Takeshi KOMIYA 2021年4月7日(水) 21:57 Fabre Lambeau : > > Is there way in Sphinx to provide links to static local HTML files (I know > the answer is "yes" to that one), but in such a way that those files are also >

Re: [sphinx-users] How to use longtable?

>I read about that but most likely I did not understand it well. I thought that >the content is a table itself ... Yes. Please put your table into the content area of the table directive. The error you saw (WARNING: Content block expected for the "table" directive; none found.) means the

Re: [sphinx-users] How to use longtable?

Hi, It seems you did not write a table mark-up as a content of the table directive. It expects table mark-up as its content. Please read the document of the directive: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table Thanks, Takeshi KOMIYA 2021年3月30日(火) 16:55 VlaMa : > >

Re: [sphinx-users] Issues with relative path for image directive on Win 10

Hi, Sorry for inconvenience. I just bumped Sphinx-3.5.3 to fix the bug. Could you try the new one? Please let me know if it does not work. Thanks, Takeshi KOMIYA 2021年3月19日(金) 16:05 Lex Margai : > > Hi, everyone > > After having installed Sphinx and Python, during a project building, multiple

Re: [sphinx-users] Displaying backslashes in UNC paths

Hi, It seems your example `volume\\folder\\` is rendered as two backslases as expected. This is a HTML output on my local. Thanks, Takeshi KOMIYA 2021年3月18日(木) 1:21 Kevin Canney : > > In a Sphinx project, I'm attempting to display UNC paths. Let's take > \\volume\folder\ for example. > >

Re: [sphinx-users] Modifying the walk/walkabout methods of a node

LGTM! 2021年2月27日(土) 21:48 Anton Akhmerov : > > Hello everyone, > > I would like to render a bundle of outputs generated by Jupyter, all > representing the same object. Some outputs are better suited for HTML and > some for pdf. So the overall logic that I want to implement is "given this >

Re: [sphinx-users] "Duplicate Implicit Target Name" : Using a subtitle name more than once

Hi, By default, Sphinx does not emit such a warning. Actually, no warnings are shown when I pasted your example to my document. How did you see it? Please let me know about the configurations or command-line options. Thanks, Takeshi KOMIYA 2021年2月26日(金) 14:42 Kishore Vanapalli : > > We have a

Re: [sphinx-users] Conditional images

Hi, I guess you need to install a blank line before the image directive. All directives expect a blank line between the declarative line and its contents. In this case, the consecutive line that contains the image directive call is considered as a part of conditions of the only directive.

Re: [sphinx-users] Apostrophes

Hi, I guess the conversion happened by the "smartquotes" feature of Sphinx. If you'd not like to do that, please disable it via `smartquotes = False` on your conf.py. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes Thanks, Takeshi KOMIYA 2021年2月20日(土) 22:34

Re: [sphinx-users] How to find broken local links when building docs

Hi, How do you make cross-references? I think Sphinx will warn if you're using `:doc:` or `:ref:` roles for such a purpose. Thanks, Takeshi KOMIYA 2021年2月16日(火) 22:51 Albertas Gimbutas : > > Hello, > > I wonder is there a way to test if there is broken local links in my > documentation?

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

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

Re: [sphinx-users] Best way to handle imported type annotations?

Hi, I have a plan to improve documentations for these imported members in 4.x. But I don't have enough time at present. Unfortunatley, there is no good way to document them better, AFAIK. Thanks, Takeshi KOMIYA 2021年1月29日(金) 9:12 Hong Xu : > > > Hi all, > > I have a question regarding typed

Re: [sphinx-users] Cannot build because of Extension error

Hi, The error says "requests" library not found. Please check and install it. Thanks, Takeshi KOMIYA 2021年1月21日(木) 1:46 castania pilonga : > > Hello, > > I recently upgraded my operating system. I had Trisquel 8 (based on Ubuntu > 16.04) and now I have Trisquel 9 (based on Ubuntu 18.04). After

Re: [sphinx-users] Connected function not being called in apidoc.

Hi, `conf.py` is a configuration file for "sphinx-build", not "sphinx-apidoc". So it will be never loaded from the command. Thanks, Takeshi KOMIIYA 2021年1月20日(水) 11:31 Joshua J. Kugler : > > I was invoking sphinx-apidoc from the command line, and all was working. > > We modified our build

Re: [sphinx-users] How to add links to the sidebar

Hi, How about using `html_sidebars`? It allows you to insert custom sidebar-parts to your pages. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars 1. Create a partial HTML as a template file 2. Put it template dir on your project (ex. _templates) 3. Check

Re: [sphinx-users] Re: rst_epilog in Sphinx - intl

y for taking long time to respond back to you. > I found special character　like ™️　and 　©︎　stop the latexpdf process. > and when removed these, the trouble solved. > > Thank you very much for taking care > > Yuji > > 2020年12月26日(土) 0:38 Komiya Takeshi : >> >>

[sphinx-users] Re: ANN: Sphinx-3.4.0 is out

Hi all, Now Sphinx-3.4.2 is out. It contains some important bugfixes for autodoc. For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.4.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA 2020年12月25日(金) 0:30 Komiya Takeshi : > > Hi all, > >

Re: [sphinx-users] autodoc reports errors for dict module variable

Hi, I think this is the same as this issue: https://github.com/sphinx-doc/sphinx/issues/8547 And there is no good way to resolve it well. Thanks, Takeshi KOMIYA 2020年10月14日(水) 16:36 Andrew Porter : > > Hello, > > I'm using autodoc in Sphinx 3.2.1 and have a problem where it reports >

Re: [sphinx-users] why linux make html different from mac？

Okay, it seems modules are correctly installed. Are there any warnings or outputs on building a document? If none, I don't have idea to fix your trouble... -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop

Re: [sphinx-users] why linux make html different from mac？

ensorgraph module is installed into your Ubuntu environment. Thanks, Takeshi KOMIYA 2020年12月28日(月) 10:50 haojie shu : > > What do you mean by "check that the module is available in your Linux > environment"? > > Komiya Takeshi 于2020年12月12日周六 上午11:49写道： >> >

Re: [sphinx-users] Re: rst_epilog in Sphinx - intl

Hi Yuji, That's strange. I believe Sphinx should output the same result both `make html` and `make latexpdf`. I guess something are cached on your environment. Could you try `make clean` before building docs? As a trial, I made a simple project including a substitution. And I succeeded to build

[sphinx-users] Re: ANN: Sphinx-3.4.0 is out

Hi all, Now Sphinx-3.4.1 is out. It contains some critical bugfixes for autodoc. For more detail, please check the CHANGES file: https://github.com/sphinx-doc/sphinx/blob/3.4.x/CHANGES Enjoy documentation! Thanks, Takeshi KOMIYA 2020年12月20日(日) 21:36 Komiya Takeshi : > > Hi all, > &

Re: [sphinx-users] dvisvgm: only for math?

Hi, Of course, you can do it with writing your own extension. As you said, imgmath is good example to make it. Thanks, Takeshi KOMIYA 2020年12月23日(水) 7:19 Denis Bitouzé : > > Hi, > > I'm trying to use Sphinx for a LaTeX FAQ (in French). > > It would be nice for LaTeX snippets to be able to be

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

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

Re: [sphinx-users] Custom Directive: how to correctly create reference to a class

https://hwtlib.readthedocs.io/en/latest/hwtLib.amba.axi_comp.lsu.html#module-hwtLib.amba.axi_comp.lsu.read_aggregator > <https://hwtlib.readthedocs.io/en/latest/hwtLib.amba.axi_comp.lsu.html#module-hwtLib.amba.axi_comp.lsu.read_aggregator> > > > Thanks. > > > On 12. 12. 20 12:22, Komiya Takeshi wrot

Re: [sphinx-users] Make the heading levels of (sub)documents automatically dependent of the depth's levels of the folders they belong to

Hi, Sphinx does not mind the depth of the document itself. It only minds how sections are "nested". To make your subsections "nested", please append sub-toctree to foo0.rst and subfolder1/foo1.rst like following: ``` # foo0.rst This a title .. toctree:: subfoloder1/foo1 ```

Re: [sphinx-users] why linux make html different from mac？

Hi, It seems the document you pasted is a document for "tensorgraph" module. Sphinx tries to build it using the module itself. Could you check that the module is available in your Linux environment? Additionally, please check the console output of sphinx build. Are there any warnings? Thanks,

Re: [sphinx-users] WARNING: Unknown interpreted text role

Hi, It seems the `role` directive only takes a lowercased role name. I succeeded to build the .rst file with `.. role:: latexlogo` in rst_prolog. I don't know this is a bug of docutils or not. Thanks, Takeshi KOMIYA 2020年12月12日(土) 1:27 Denis Bitouzé : > > In my Sphinx-doc instance, I have: > >

Re: [sphinx-users] FileNotFoundError: [Errno 2] No such file or directory: 'katex': 'katex'

Hi, It seems sphinxcontrib-katex tries to invoke katex command, but failed because of command not found. I guess you've enabled katex_prerender feature, right? If so, you need to install katex command on your local. Could you check it please? Thanks, Takeshi KOMIYA 2020年10月8日(木) 18:24 Murtaza

Re: [sphinx-users] How to set text not translatable (i18n)

> May i ask another question here (if you say no, i'll make another discussion) Of course, yes :-) > I made a custom directive that generates a video and displays it. But the > video generation process is quite long, and, when i launch sphinx gettext or > pdf target, the videos takes a lot of

Re: [sphinx-users] How to set text not translatable (i18n)

Hi, Unfortunately, there is no way to do that. Please write a code to customize it. There are many software to manipulate .po files! Thanks, Takeshi KOMIYA 2020年11月28日(土) 21:42 Mysaa Java : > > > Hello. > I used sphinx gettext to export my docs to .pot files. But this process > exports too

Re: [sphinx-users] Different index files for latex and html

Hi, My suggestion is using orphan metadata. https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata 2020年11月24日(火) 19:23 Stefano David : > > Hi, > > I know I read something about my problem somewhere, but I can not find > references to it anymore. > > Scenario: I

Re: [sphinx-users] esaping { and } in :samp: role

Hi, Please use double backslashes to escape curly braces :samp:`\\{ {x} , {y} \\}`. Thanks, Takeshi KOMIYA 2020年11月14日(土) 20:35 bradley...@gmail.com : > > In the following documentation > https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-samp > > It says: > Changed in

Re: [sphinx-users] What Sphinx changes on gh-pages branch

Hi, The files under `.doctrees` directory are generated on building as intermediate file. So they don't need to be committed to your repo. So please remove them before committing (or give `-d` option to create it outside of your repo). Thanks, Takeshi KOMIYA 2020年10月20日(火) 23:58

Re: [sphinx-users] How to get Sphinx 4?

Hi, It isn't released yet. We have a plan to release it next Spring. Until then, please install it from our GitHub repository. Thanks, Takeshi KOMIYA 2020年11月5日(木) 4:25 Łukasz Piłatowski : > > Hi, > In the docs I can see :canonical: keyword (above final here - >

Re: [sphinx-users] Re: generating PDF using latex for Chinese, Korean, Japanese

Hi, How about passing `-D latex_engine=platex` from command line option on building Japanese docs. Thanks, Takeshi KOMIYA 2020年11月1日(日) 21:07 Pieter Claeys : > Update: got Japanese PDF working by simply having 'engine=platex' in > conf.py > > If anyone has a pointer how to check on the

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

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

Re: [sphinx-users] Execute Python code after the documentation has been built

Hi, How about add an instruction into Makefile? I believe it's very simple! Thanks, Takeshi KOMIYA 2020年10月22日(木) 19:34 Zoltan : > > > I need to copy a file before the documentation generation starts. I put this > to the beginning of conf.py: > > from shutil import copy >

Re: [sphinx-users] Filtering/distinguishing search results by page type in Sphinx search

Hi, Even if you made an indexer extension, Sphinx can't separate (or filter) contents on searching because search-engine (in JS) does not have such a feature. So you need to replace search-engine also. >PS: If this helps, all the class reference pages are under the same parent >`classes/`

[sphinx-users] sphinx-testing: Call for maintainers

Hi, Since 1.6, we migrated to pytest and integarted the testing package to sphinx-core as sphinx.testing. As a result, sphinx-testing package has been no longer maintained for a long time. Additionally, nose project has also been not maintained now (the latest release is in 5 years ago!). So I'm

Re: [sphinx-users] rst syntax parsing in languages not using spaces (eg. japanese, korean)

Hi, I usually use a technique that inserts an escaped space before and after the decorated word. For example, you can emphasize a word\ *like this*\ using escaped spaces. It allows you to decorate without spaces. I know this is annoying. But it helps us. BTW, trimblank extension might help you.

Re: [sphinx-users] Adding :members: in autoclass

Hi, How about using `autodoc_default_options`? It can pass :members: option to all of auto* definitions in your document. https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options Thanks, Takeshi KOMIYA 2020年10月1日(木) 0:01 Danylo Ulianych : > > Dear all,

Re: [sphinx-users] make latexpdf

Hi, You need to run pdflatex command multiple times to build complete PDF file. For more detail, please read the following article. https://www.systutorials.com/why-do-i-need-to-run-latex-bibtex-three-times-to-make-everything-look-good/ Instead of pdflatex command, you can use `make` command

Re: [sphinx-users] get list of C functions/structs/etc...

Hi, There is no such feature. You need to write a code to extract data from Sphinx. This is an example code to get the list of C objects. Please append this into your conf.py. ``` def on_env_check_consistency(app, env): domain = env.get_domain('c') for c_object in domain.get_objects():

Re: [sphinx-users] Sphinx not highlighting code it should

Hi, I think your code block contains a syntax error. Could you check the text is valid using `pygmentize -l powershell -F raiseonerror` command? If it contains syntax error, you need to pass `:force:` option to the code-block directive. Thanks, Takeshi KOMIYA 2020年9月12日(土) 7:31 Joshua J.

Re: [sphinx-users] Trying to exclude files not working

t matches that pattern, not just a > relative reference, no? > > j > > On Friday, September 4, 2020 7:37:35 PM AKDT Komiya Takeshi wrote: > > Hi, > > > > It seems your MODULE_PATH starts with "..". How about prepending ".." > > to the exclude paths

Re: [sphinx-users] Selective inclusion of Javascript

At present, I don't have a good idea about the new API. Any proposal is welcome :-) 2020年9月5日(土) 19:06 Anton Akhmerov : > > Hi Takeshi, > > Would you have some pointers or suggestions as to how a possible > implementation could work? > > Best, > Anton > On Saturday, 5 September 2020 at 12:00:19

Re: [sphinx-users] Selective inclusion of Javascript

Hi, I have a similar report: https://github.com/sphinx-doc/sphinx/issues/6241 But I don't have time to work on it. Any contributions are welcome :-) Thanks, Takeshi KOMIYA 2020年8月31日(月) 17:50 Stefano David : > > Hi all, > > We all know we can include JS files using app.add_js_file. This however

Re: [sphinx-users] csv-table widths not working for me

Hi, On my local, Sphinx outputs tag using `:withds:` option. I think it works well in latest Sphinx. Could you check generated HTML in your document? Thanks, Takeshi KOMIYA 2020年8月31日(月) 22:10 Rob Torop : > > I am using csv-table to read in a csv and display as a table. It works in >

Re: [sphinx-users] Trying to exclude files not working

Hi, It seems your MODULE_PATH starts with "..". How about prepending ".." to the exclude paths? sphinx-apidoc -f -e -M --implicit-namespaces -o ./modules ../devkit/ '../test_files/*' Thanks, Takeshi KOMIYA 2020年8月18日(火) 9:41 Joshua J. Kugler : > > sphinx-apidoc says: > > """ > sphinx-apidoc

Re: [sphinx-users] Inviting Sphinx users to ask their questions on StackOverflow?

Hi all, It seems no objections for the migration to SO. As a trial, I'll start to invite users who try to post a question to GH. But it does not mean we shutdown this list. Thanks, Takeshi KOMIYA 2020年8月8日(土) 5:33 Yves Chevallier : > > I recently created this >

Re: [sphinx-users] Disambiguating intersphinx references

Hi, I'm not familiar with sphinx-gallery. So I'm saying about only intersphinx's behavior. The intersphinx works as a fallback on resolving cross-references. So Sphinx tries to resolve it on local document at first. And it calls intersphinx only if not resolved. In other words, all of the

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

Hi all, Today, I released Sphinx-3.2.1. It contains some bug fixes around autodoc and napoleon extensions. 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

Re: [sphinx-users] 3.2.0 in PyPi, 4.0.0 docs

Hi, >How does one acquire 4.0.0? It is still in development. Please install it via GitHub. >Why were the docs released before the code? No special reason. It contains all of descriptions for older releases. So I think no problem. Thanks, Takeshi KOMIYA 2020年8月14日(金) 9:49 Joshua J. Kugler : >

Re: [sphinx-users] autodoc-skip-member isn't seeing all functions?

Hi Joshua, Thank you for reporting. I believe it should be improved. Could you file an issue to GitHub, please? Then I'll work on it. Thanks, Takeshi KOMIYA 2020年8月12日(水) 9:34 Joshua J. Kugler : > > On Monday, August 10, 2020 12:54:59 PM AKDT Joshua Kugler wrote: > > I have an oddity here. I

Re: [sphinx-users] Access to Sphinx AST before transforms/post-transforms

Hi, How about using a transform having a very high priority? Then you can access a doctree (a.k.a. AST) just after the parsed. Thanks, Takeshi KOMIYA 2020年8月10日(月) 10:49 Matt McKay : > > Hi Sphinx Group. > > Is there a way to access the Sphinx abstract syntax tree (AST) before any > transforms

Re: [sphinx-users] Attributes set to a node during the EnvironmentCollector vanishes

Hi, The collector.get_updated_docs() is called to detect output files that is needed to be re-generated. It is called just after the reading phase. It means the event is designed as read-only. For example, it is useful to detect files that is effected to the change of ToC numbers when a new

  1   2   3   4   5   6   >