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

[Komiya Takeshi]

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



Item 2
```

There are two target nodes. First is placed before enumerated_list,
and another is placed at the tail of the first list_item.
And you can also see the ids attribute on the enumerated_list and the
second list_item.
Docutils automatically copies an ID from the target node to the subsequent node.

This is why your mark-up works.

2022年7月13日(水) 15:11 Steevie :
>
> Hi Josué,
>
> On Tue, 12 Jul 2022 07:37:35 -0300, Josué Andrade Gomes wrote:
>
> > Hi,
> >
> > I’m trying to create a hyperlink to an autonumbered list item. The
> > hyperlink works fine but the items are not correctly numbered.
> >
> > Sample --
> >
> > See: :ref:`This ` and :ref:`That `
> >
> > Items -
> >
> > .. _item-1:
> >
> > #. Item 1
> >
> > .. _item-2:
> >
> > #. Item 2
>
> I can confirm the behaviour, which indeed is a bit strange. However, I
> made a quick test with the second label indented and it works:
>
> .. _item-1:
>
> #. Item 1
>
>.. _item-2:
>
> #. Item 2
>
>  Not sure this solution some unwanted side-effects, though!
>
> Hope this helps,
> Stefano
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/talnmd%24jc2%241%40ciao.gmane.io.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANx9Cw8zZxjHi2dzEAJHi2nj7h%3DCtDJrf_YaK26uABR%3Dg%40mail.gmail.com.

[sphinx-users] Sphinx-5.0.0 is out

[Komiya Takeshi]

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:
https://github.com/sphinx-doc/sphinx/blob/5.0.x/CHANGES

Thanks to all collaborators and contributors!

What is it?
===

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText source files).

Website: http://sphinx-doc.org/

Enjoy!

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO97T6yoXbDxPZQOCTbMUKsVsyvMrzB%3DuadenrZRcFfaQ%40mail.gmail.com.

[sphinx-users] Call for translation updates

[Komiya Takeshi]

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 team, and translate or
review translations. If your language does not exist, please make a
language request to us. We'll add it ASAP.

We have a plan for releasing sphinx-5.0.0 final in the end of May
(maybe 28-29th).

Thanks,
Takeshi KOMIYA

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOd%3DZWc1NDmi%3Da9vvWP%2B8BYW-Y_s%3D20XQV7Lw82kL18Ag%40mail.gmail.com.

[sphinx-users] Sphinx-5.0.0b1 released

[Komiya Takeshi]

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 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

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMvE7PpETzu3a6t6F_Auo%3D2Wh077CcaHzKjQHs_UZ17EA%40mail.gmail.com.

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

[Komiya Takeshi]

Hmm... that's strange. Could you post an issue to Sphinx repo with
reproducible project (including conf.py and python scripts), please?
Then I'll investigate it more.

Thanks,
Takeshi KOMIYA

2022年3月31日(木) 2:17 'Alex Botev' via sphinx-users
:
>
> So the reST document is literally:
>
> .. currentmodule:: my_module
>
> Standard API
> 
>
>
> MySection
> -
>
> .. autosummary::
>
> TopClass
>
> TopClass
> ~
>
> .. autoclass:: TopClass
>:members:
>
>
> On Wed, Mar 30, 2022 at 6:14 PM Komiya Takeshi  wrote:
>>
>> 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:
>> >   """Persistent state."""
>> >   a: int
>> >   b: int
>> >   c: int
>> > ```
>> > Running autodoc correctly picks up InternalClass, but I get a lot of its 
>> > private members documented, e.g.:
>> > __dataclass_params__= 
>> > _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,
>> >  frozen=False) __dict__= mappingproxy({'__module__': 'my_module.try', 
>> > '__annotations__': {'a': 'int', 'b': 'int', 'c': 'int'}, '__doc__': 
>> > 'Persistent state.', '__dict__': > > objects>, '__weakref__': , 
>> > '__dataclass_params__': 
>> > _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False),
>> >  '__dataclass_fields__': {'a': 
>> > Field(name='a',type='int',default=> > object>,default_factory=> > object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
>> >  'b': Field(name='b',type='int',default=> > object>,default_factory=> > object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
>> >  'c': Field(name='c',type='int',default=> > object>,default_factory=> > object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD)},
>> >  '__init__': .__init__>, '__repr__': 
>> > .__repr__>, '__eq__': > > __create_fn__..__eq__>, '__hash__': None}) __eq__(other) Return 
>> > self==value. __hash__= None __init__(a, b, c)
>> >
>> > How can I prevent this?
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users+unsubscr...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/2451dc5a-f3d8-43e0-a197-dc6afa8a34d9n%40googlegroups.com.
>>
>> --
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx-users+unsubscr...@googlegroups.com.
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/sphinx-users/CAFmkQANagzJDJZajUueXd8hPugpGMNEV2P0yXxExjfwXKz1w0A%40mail.gmail.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/CAPjNthsR_i9bi_dhe_q-AYOU4Gs8GfEjRNknASEFT_mM-O0Gsw%40mail.gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOG4JewaDzVYoggn57pr%3DHFScpze1nBS2vx51PszXF2LQ%40mail.gmail.com.

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

[Komiya Takeshi]

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:
>   """Persistent state."""
>   a: int
>   b: int
>   c: int
> ```
> Running autodoc correctly picks up InternalClass, but I get a lot of its 
> private members documented, e.g.:
> __dataclass_params__= 
> _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False, 
> frozen=False) __dict__= mappingproxy({'__module__': 'my_module.try', 
> '__annotations__': {'a': 'int', 'b': 'int', 'c': 'int'}, '__doc__': 
> 'Persistent state.', '__dict__':  objects>, '__weakref__': , 
> '__dataclass_params__': 
> _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False),
>  '__dataclass_fields__': {'a': 
> Field(name='a',type='int',default= object>,default_factory= object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
>  'b': Field(name='b',type='int',default= object>,default_factory= object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD),
>  'c': Field(name='c',type='int',default= object>,default_factory= object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),_field_type=_FIELD)},
>  '__init__': .__init__>, '__repr__': 
> .__repr__>, '__eq__':  __create_fn__..__eq__>, '__hash__': None}) __eq__(other) Return 
> self==value. __hash__= None __init__(a, b, c)
>
> How can I prevent this?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/2451dc5a-f3d8-43e0-a197-dc6afa8a34d9n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANagzJDJZajUueXd8hPugpGMNEV2P0yXxExjfwXKz1w0A%40mail.gmail.com.

Re: [sphinx-users] Custom docstring format

[Komiya Takeshi]

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 'Johannes Luther' via sphinx-users
:
>
> Hi sphinx-users,
> maybe I have a weird requirements or more like a question whether the 
> following is possible using sphinx.
> I'm using Python code to define testcases using a predefined testing 
> framework (pyATS).
>
> So within this framework, test cases are defined as Python classes with 
> multiple test steps as methods within this class. Example
>
> class myTestCase1(aetest.Testcase):
>   @aetest.test
>   def myTestStep1(self):
>  #... Test code
>   @aetest.test
>   def myTestStep2(self):
>  #... Test code
> class myTestCase2(aetest.Testcase):
> # ...
>
> So I don't really need to document classes in the usual way, because there 
> are no arguments etc. It's more like a container class.
>
> What I like to achive is a "human readable" Test Case documentation from the 
> code.
> If using the example from above:
> class myTestCase1(aetest.Testcase):
>   ''' myTestCase1
>   :test-purpose: The purpose of this test is to check whether spiderman is 
> cool.
>   :test-environment: Please refer to 
>   :test-description: Ask 100 people if spiderman is cool
>   :test-expected-results: At least 51 people think that spiderman is cool
>   '''
>   @aetest.test
>   def myTestStep1(self):
>  #... Test code
>   @aetest.test
>   def myTestStep2(self):
>  #... Test code
> class myTestCase2(aetest.Testcase):
> # ...
>
> Hope you get the point... So I want to generate a document (preferably a 
> markdown document) based on a jinja2 template, where I can access the 
> definitions from above like :test-description:
>
> Is something like this achivable using sphinx?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/12ed5e39-e75a-4a63-801c-3475f88bc314n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPhJ0RvM8fD-fcGjVPYCjRcYmuTebqQqe4mQCXkd15UXg%40mail.gmail.com.

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

[Komiya Takeshi]

> Now my next question would be: would a PR adding such a role
> be welcome? Would it be preferable for it to live in
> a PyPI extension at least in a first step?

Basically, the standard role of Sphinx should be widely used by many people.
I'm not sure the :metavar: is a widely 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/2022 à 06:05, Komiya Takeshi a écrit :
> > 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.
>
>
> As said privately, thank you for your reply. Now my
> next question would be: would a PR adding such a role
> be welcome? Would it be preferable for it to live in
> a PyPI extension at least in a first step? Or actually,
> perhaps it could be proposed in Docutils?
>
> Best regards,
> Jean
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPmif2tpf3y9CBuk3358iVG4ar%2BC5z2Kc9MmnQTFH7VCA%40mail.gmail.com.

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

[Komiya Takeshi]

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 semantic markup.
> However, working with Texinfo in parallel, I find one command
> that is miss, which is Texinfo's @var. It serves roughly the
> same purpose as what's in curly braces inside :samp: (when
> nested inside Texinfo's @code), except that it can be used outside
> as well. For instance, assuming that I could write it as
> :var:`x`, I might write::
>
> The syntax for this command is :samp:`\spam {eggs}`, where
> :var:`eggs` is a non-empty set of eggs.
>
> or::
>
> This property is used as
>
> .. parsed-literal::
>
>\badly \frobnicate :var:`stuff`
>
> Here, :var:`stuff` is ...
>
> Another use case: in the Python documentation at least
> (I don't have experience with Sphinx in other
> projects), the names of function parameters are
> marked up in *italics*. As a perfectionist, I would
> in my own documentation prefer to mark them up with
> some specific role showing their intent, possibly
> enabling different styling in HTML, maybe some form
> of underlining. It's true that there may be a point
> in making it domain-specific and allowing, for
> example, backlinks to the parameter's default,
> and annotation if present, especially in function
> descriptions with :param: where the argument
> appears on its own line separate from the function header.
> On the other hand, my own use cases are not for API
> documentation with formal objects like functions or
> classes, but narrative documentation (is that the
> proper term?) that describes tons of elements with
> completely different natures, organized by topic
> rather than nature of objects. This documentation is
> also for projects not primarily used by developers.
>
> In Info output (I don't care about it but some do),
> @var ends up in capital letters, unlike italics
> which are marked up as _word_. Looking in Sphinx's
> code, I don't find anything that would output @var
> in the Texinfo writer except for {} sections inside
> :samp:.
>
> My question is: is there something for this already?
> Should I stop thinking in Texinfo and use something
> else? Should I implement it in an extension?
>
> Thanks,
> Jean
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d7184d02-87f5-cc2a-50b3-6913c84f4d6a%40abou-samra.fr.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOJXkrG5r7Vp-GEbaLwzv%3DdhFmSiMKjY%2BmPrXUBjk7jtw%40mail.gmail.com.

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

[Komiya Takeshi]

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 adds a 
> new section based on parsing a config file. As long as I return paragraph 
> nodes, then the directive works fine, but when I return section nodes, the 
> program errors out with the following message:
>
> $ sphinx-build docs _build
> Running Sphinx v4.2.0
> building [mo]: targets for 0 po files that are out of date
> building [html]: targets for 2 source files that are out of date
> updating environment: [new config] 2 added, 0 changed, 0 removed
> reading sources... [100%] test
> Extension error (sphinx.environment.collectors.toctree):
> Handler   0x7f5803601190>> for event
>   'doctree-read' threw an exception (exception: list index out of range)
>
> This is what a stripped down version of my extension looks like:
>
> from docutils import nodes
> from docutils.parsers.rst import Directive
>
> class HelloSection(Directive):
> def run(self):
> section_dir = nodes.section()
> section_dir += nodes.title(text="An example")
> section_dir += nodes.paragraph(text="Hello, world")
>
> return [section_dir]
>
> def setup(app):
> app.add_directive('hellosection', HelloSection)
> return {
> "version": "0.1.0",
> "parallel_read_safe": False,
> "parallel_write_safe": False,
> }
>
> And my conf.py
>
> import os
> import sys
> sys.path.append(os.path.abspath('./_ext'))
>
> project = 'extension-testing'
> copyright = '2022, Thomas Christensen'
> author = 'Thomas Christensen'
>
> extensions = [
> 'hellosection',
> ]
>
> html_theme = 'alabaster'
>
> I'm having trouble even debugging this to find out where the error actually 
> is. Can anyone please tell me what I'm doing wrong and how to fix it?
>
> Thank you,
> Thomas Christensen
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/572fc7c8-9d92-1739-9e40-6e4414f993be%40vet.k-state.edu.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANfS55W%3DD5MwKgGfR6GnCvy2T0R7a2zuXHG_RZhRgtp8A%40mail.gmail.com.

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

[Komiya Takeshi]

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 building its 
> documentation using Sphinx for years. Thanks for sharing Sphinx with the rest 
> of the world :-D
>
> In the recent days one of our Github actions picked up the latest versions of 
> Sphinx and Pygments, which results in a build warning (which we treat as a 
> failure, trying to keep documentation in good shape). The versions involved 
> are:
>
> Sphinx is version 4.3.2
> Pygments version is 2.11.1
>
>
> The directive failing is a simple:
>
> .. literalinclude:: 
> /../src/main/java/org/geotools/tutorial/csv3/parse/CSVStrategy.java
> :language: java
> :start-after: // docs start createBuilder
> :end-before: // docs end findMostSpecificTypesFromData
>
> and the file included is this one:
> https://github.com/geotools/geotools/blob/main/docs/src/main/java/org/geotools/tutorial/csv3/parse/CSVStrategy.java#L66
>
> The error message just states lexing did not work:
>
>  [exec] Warning, treated as error:
>  [exec] 
> /home/aaime/devel/git-gt/docs/user/tutorial/datastore/strategy.rst:245:Could 
> not lex literal_block as "java". Highlighting skipped.
>
> However I've tried to use "pygmentize" on the command line, it highlights the 
> file without errors. Also tried leaving just the section of code that is 
> meant to be highlighted, same results, no errors, e.g:
>
> > pygmentize   -V
> Pygments version 2.11.1, (c) 2006-2021 by Georg Brandl, Matthäus Chajdas and 
> contributors.
> > pygmentize   -l java 
> > /home/aaime/devel/git-gt/docs/src/main/java/org/geotools/tutorial/csv3/parse/CSVStrategy.java
> (works fine, output omitted)
>
> I'm stuck here... any idea of what I could do to address this issue?
>
> Cheers
> Andrea
>
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/84e651ea-ae48-4153-b51d-76a1f5b90944n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMy9phLDFoV3ggGisV%3DXDnyk7kynT2JzcAS3suPNxmDUA%40mail.gmail.com.

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

[Komiya Takeshi]

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 Filipino in Native Language Support.
> https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language
>
> Will this be possible?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f15e83c0-67ab-437e-bfd6-7c036febd6edn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAORTB2kQpvsg-J_MYZM9d5W1pzRM1-AKjtYCn%3DZ_1rh_A%40mail.gmail.com.

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

[Komiya Takeshi]

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 for example looks for a link image URL 
> header. If no such header is present, it probably looks for the first picture 
> on the page, which is not necessarily what we want. How can we spcify an 
> explicit link image url for a page?
>
> Luc
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f0efdb12-1d0d-e68d-6ccd-5cbd1fcbfdbb%40gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO2%2B_DKX7ARx9MrFpgkgpTTtQns5o1vCQG1i0VR4jf8-Q%40mail.gmail.com.

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

[Komiya Takeshi]

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 conditionaly. The use case I am thinking of is, 
> that I create wikimedia output which I currently automatically post to our 
> internal wiki.
>
> I would like it to conditially output a  notice that says "Generated from 
> sphinx.Do not edit, update and buildwill 
> update this wiki entry"
>
> But I would not want the message showing when the output is html or pdf.
>
> Thanks
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/c9de65cc-48f4-4d0b-a812-8794b55a3d22n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM%3Dk2obhZsoebSzBV%2B3ibGBS3ioDkTfT2jFKopgL-VrMA%40mail.gmail.com.

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

[Komiya Takeshi]

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.

$ echo '$ A prompt' | pygmentize -l bash -f html
$ A prompt


So some contribution would be needed for pygments, I think.

Note: I used pygments-2.10.0

$ pygmentize -V
Pygments version 2.10.0, (c) 2006-2021 by Georg Brandl, Matthäus
Chajdas and contributors.

2021年9月15日(水) 0:03 Ron Stone :
>
> Thanks again. That sounds simple enough from a user perspective. With:
>
> .. code-block:: bash
>
>$ A prompt?
>
> The '$' should be unelectable in the output, but this is pasted from the html:
>
> $ A prompt?
>
> I am using 4.2
>
> On Tuesday, September 14, 2021 at 10:54:56 AM UTC-4 i.tk...@gmail.com wrote:
>>
>> 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 and non-prompt in a code block?
>> >
>> > 1. Is there a new mechanism to specify a prompt, similar to the 
>> > sphinx-prompts extension?
>> > 2. Is there some markup within the block to identify the prompt?
>> > 3. Are certain characters at the front of a line detected and treated as 
>> > prompts, such as '$' for bash?
>> >
>> > R.
>> >
>> > It would be useful to see a minimal working example of this.
>> >
>> > On Tuesday, September 14, 2021 at 9:48:51 AM UTC-4 i.tk...@gmail.com wrote:
>> >>
>> >> 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 sphinx-dev but now believe it belongs here. 
>> >> > Apologies for cross-posting.
>> >> >
>> >> > I am using Sphinx 4.2. I see this merge re making prompts in code 
>> >> > blocks unelectable.
>> >> >
>> >> > https://github.com/sphinx-doc/sphinx/pull/9120
>> >> >
>> >> > I don't see any documentation of how this works here:
>> >> > https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=code-block
>> >> >
>> >> > and building a typical code-block such as the following does not 
>> >> > demonstrate changed behaviour.
>> >> >
>> >> > .. code-block:: bash
>> >> >
>> >> > ls
>> >> >
>> >> > or
>> >> >
>> >> > .. code-block:: bash
>> >> >
>> >> > $ ls
>> >> >
>> >> > Can someone please explain how this is configured and invoked?
>> >> >
>> >> > Thanks.
>> >> >
>> >> > --
>> >> > You received this message because you are subscribed to the Google 
>> >> > Groups "sphinx-users" group.
>> >> > To unsubscribe from this group and stop receiving emails from it, send 
>> >> > an email to sphinx-users...@googlegroups.com.
>> >> > To view this discussion on the web visit 
>> >> > https://groups.google.com/d/msgid/sphinx-users/29b9917f-6e18-430a-9765-42553f74a687n%40googlegroups.com.
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/fd008e21-fca1-4e0b-8686-0f4b4180a04dn%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/b88e9e00-e69e-4654-8d2c-146832831640n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOOXk9GxFB31%3D6feLnyGf%3DcgEvArmDL%3DHXN%2B%2B0kdFaTYA%40mail.gmail.com.

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

[Komiya Takeshi]

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 and non-prompt in a code block?
>
> 1. Is there a new mechanism to specify a prompt, similar to the 
> sphinx-prompts extension?
> 2. Is there some markup within the block to identify the prompt?
> 3. Are certain characters at the front of a line detected and treated as 
> prompts, such as '$' for bash?
>
> R.
>
> It would be useful to see a minimal working example of this.
>
> On Tuesday, September 14, 2021 at 9:48:51 AM UTC-4 i.tk...@gmail.com wrote:
>>
>> 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 sphinx-dev but now believe it belongs here. 
>> > Apologies for cross-posting.
>> >
>> > I am using Sphinx 4.2. I see this merge re making prompts in code blocks 
>> > unelectable.
>> >
>> > https://github.com/sphinx-doc/sphinx/pull/9120
>> >
>> > I don't see any documentation of how this works here:
>> > https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=code-block
>> >
>> > and building a typical code-block such as the following does not 
>> > demonstrate changed behaviour.
>> >
>> > .. code-block:: bash
>> >
>> > ls
>> >
>> > or
>> >
>> > .. code-block:: bash
>> >
>> > $ ls
>> >
>> > Can someone please explain how this is configured and invoked?
>> >
>> > Thanks.
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/29b9917f-6e18-430a-9765-42553f74a687n%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/fd008e21-fca1-4e0b-8686-0f4b4180a04dn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAN22F7AFS%3DHR4qH8H9mZNbP8-r6TG8gJeKh_18EMPuGUg%40mail.gmail.com.

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

[Komiya Takeshi]

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 sphinx-dev but now believe it belongs here. 
> Apologies for cross-posting.
>
> I am using Sphinx 4.2. I see this merge re making prompts in code blocks 
> unelectable.
>
> https://github.com/sphinx-doc/sphinx/pull/9120
>
> I don't see any documentation of how this works here:
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=code-block
>
> and building a typical code-block such as the following does not demonstrate 
> changed behaviour.
>
> .. code-block:: bash
>
>ls
>
> or
>
> .. code-block:: bash
>
>$ ls
>
> Can someone please explain how this is configured and invoked?
>
> Thanks.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/29b9917f-6e18-430a-9765-42553f74a687n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPzoytXf-dji-4R3aaLe4zwDA6bn12v%2BzU-6MENEoox%3DA%40mail.gmail.com.

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

[Komiya Takeshi]

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 search the entry using user's input (searching)

What are you interested in? I will try to show you a pointer.

Thanks,
Takeshi KOMIYA

2021年8月30日(月) 23:02 Tom Diaz :
>
> I'm a relative newcomer to sphinx.
>
> What is the best documentation explaining how its standard search facilities 
> work?  I have not found the right information yet, I don't think.
>
> Thanks.
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/6af674e3-7f3a-4a5d-8591-71d1a12b0f0en%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPTNoGPoPe294FZSF-z%2Bg1ZU_O07vJE7XXorjgJCzc%2Bhg%40mail.gmail.com.

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

[Komiya Takeshi]

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 :
>
> Hi,
>
> I'm using sphinx with sphinx-apidoc (though that part might be irrelevant, 
> except that it means my *.rst files are automatically generated so I can't 
> manually tweak them) and trying to figure out how to tell sphinx to use the 
> :anotation: option for all autodata calls.  I can't find a place to set 
> default options like that in conf.py.  Any pointers?
>
> Thanks,
> --Jeff
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/a010737a-2307-4a2c-8ad3-562fd5fbfb45n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO1NdNZQ1e%2BYn5OVEUAjK8moCKX2NkcKDQCAzova%3DsWnQ%40mail.gmail.com.

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

[Komiya Takeshi]

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
would be better to use newer ones.

Thanks,
Takeshi KOMIYA

2021年8月1日(日) 11:45 Ramesh Babu.R :
>
>
> Hi, We are facing an issue where "make html" fails when executing from "sudo 
> python" location.
> Same command works when python was sourced without sudo. Any pointers would 
> be helpful.
>
> Fails when executing from sudo:
>
> [jenkins@jenkins BUILD_TAG_validate_Fri_Jul_30_15_31_30_2021_]$ sudo 
> /opt/cisco/aci/python2.7/bin/python
>
> Python 2.7.14 (default, Apr 12 2018, 19:30:39)
>
> [GCC 4.4.7 20120313 (Red Hat 4.4.7-18)] on linux2
>
> Type "help", "copyright", "credits" or "license" for more information.
>
> >>> import os
>
> >>> os.system('make html')
>
> sphinx-build -b html -d _build/doctrees   . _build/html
>
> make: sphinx-build: Command not found
>
> make: *** [html] Error 127
>
> 512
>
> >>>
>
> Works without sudo:
>
> [jenkins@jenkins BUILD_TAG_validate_Fri_Jul_30_15_31_30_2021_]$ 
> /opt/cisco/aci/python2.7/bin/python
>
> Python 2.7.14 (default, Apr 12 2018, 19:30:39)
>
> [GCC 4.4.7 20120313 (Red Hat 4.4.7-18)] on linux2
>
> Type "help", "copyright", "credits" or "license" for more information.
>
> >>> import os
>
> >>> os.system('make html')
>
> sphinx-build -b html -d _build/doctrees   . _build/html
>
> Running Sphinx v1.8.5
>
> loading pickled environment... done
>
> building [mo]: targets for 0 po files that are out of date
>
> building [html]: targets for 0 source files that are out of date
>
> updating environment: 0 added, 0 changed, 0 removed
>
> looking for now-outdated files... none found
>
> no targets are out of date.
>
> build succeeded.
>
>
>
> The HTML pages are in _build/html.
>
>
>
> Build finished. The HTML pages are in _build/html.
>
> 0
>
> >>>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/c8ee4c7f-dab8-43fd-8b64-b9cf8a6a0667n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOf%3DtFYVGjZWbcKLbaj0w_yWJPnJJr6u8_SNU-0zJQFuA%40mail.gmail.com.

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

[Komiya Takeshi]

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 'Denis CARDON' via sphinx-users
:
>
> Hi everyone,
>
> I have a question on sphinx-apidoc for merging apidoc ouput in one
> sphinxdoc. My issue : I have a project (wapt[1]) which use python for
> deployment scripting on Windows, Linux and MacOS. The scripting is
> written using helpers function which we call setuphelpers. Those
> functions are mostly common among all the platform, but some are
> platform specific, and can only be loaded on that specific platform.
>
> As sphinx-apidoc import the modules, setuphelpers Python module for
> Windows can only be loaded on Windows, the same for linux and macOS.
> Running Sphinx-ApiDoc gives me the right output for each platform, but I
> would like to merge them into one sphinx document, with something like
> this in the rtd menu :
>
> * setuphelpers for Windows
>
> * setuphelpers for Linux
>
> * setuphelpers for macOS
>
> Sphinx-build with sphinx.ext.autodoc only output only html. Is there a
> way to tell sphinx.ext.autodoc to output intermediate RST files in order
> to merge them into a unified document?
>
> Thanks,
>
> Denis
>
> [1] https://github.com/tranquilit/WAPT
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/1d3bfc31-ba50-6f9a-f75d-ce7ad63fd664%40tranquil.it.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANtC9s7eZuuoWMO%2BMmTqS%3DbBcqV%2ByrennhjBBuV%3DUmwCw%40mail.gmail.com.

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

[Komiya Takeshi]

Sorry for troubling on updating Sphinx. I just bumped Sphinx-4.1.1. It
can be installed without dependency troubles.

Thanks,
Takeshi KOMIYA

2021年7月12日(月) 3:40 Luc Saffre :
>
> After upgrading, I have the following traceback and in all my doctrees, and I 
> have no idea why. Neither "epub3" nor "RemovedInSphinx40Warning" occur in any 
> of my source files. Any hints?
>
> Luc
>
> Invoke sphinx-build -b html -T -d 
> /home/luc/mypy/lino_local/jsvv/docs/.build/.doctrees -W --keep-going . 
> /home/luc/mypy/lino_local/jsvv/docs/.build
> Running Sphinx v4.1.0
> loading translations [et]... done
>
> Traceback (most recent call last):
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/registry.py", 
> line 429, in load_extension
> mod = import_module(extname)
>   File "/home/luc/virtualenvs/py3/lib/python3.6/importlib/__init__.py", line 
> 126, in import_module
> return _bootstrap._gcd_import(name[level:], package, level)
>   File "", line 994, in _gcd_import
>   File "", line 971, in _find_and_load
>   File "", line 955, in _find_and_load_unlocked
>   File "", line 665, in _load_unlocked
>   File "", line 678, in exec_module
>   File "", line 219, in _call_with_frames_removed
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/epub3.py",
>  line 18, in 
> from sphinx.builders import _epub_base
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/_epub_base.py",
>  line 23, in 
> from sphinx.builders.html import BuildInfo, StandaloneHTMLBuilder
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/builders/html/__init__.py",
>  line 1288, in 
> import sphinxcontrib.serializinghtml  # NOQA
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinxcontrib/serializinghtml/__init__.py",
>  line 16, in 
> from sphinx.deprecation import RemovedInSphinx40Warning, deprecated_alias
> ImportError: cannot import name 'RemovedInSphinx40Warning'
>
> The above exception was the direct cause of the following exception:
>
> Traceback (most recent call last):
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/cmd/build.py", 
> line 279, in build_main
> args.tags, args.verbosity, args.jobs, args.keep_going)
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/application.py",
>  line 233, in __init__
> self.setup_extension(extension)
>   File 
> "/home/luc/virtualenvs/py3/lib/python3.6/site-packages/sphinx/application.py",
>  line 393, in setup_extension
> self.registry.load_extension(self, extname)
>   File 
> "/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')
>
> Extension error:
> Could not import extension sphinx.builders.epub3 (exception: cannot import 
> name 'RemovedInSphinx40Warning')
> C
>
>
> On 11.07.21 20:29, Komiya Takeshi wrote:
>
> 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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO8q9UQ5kVqAzFkqnyg2PAL5SH2yxMzsSahEDvL1nf2_Q%40mail.gmail.com.

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

[Komiya Takeshi]

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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAP0cjiTR4cfg%2BknM1%2B9k3ANS9cdC1gffAaGYus8W_s4dw%40mail.gmail.com.

Re: [sphinx-users] Sphinx 4.1 release plan

[Komiya Takeshi]

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,
>
> Firstly, thanks for providing the awesome Sphinx! I'm looking forward to the 
> 4.1 release. To that end: I see the milestone on GitHub has expired a while 
> ago, and I was wondering what the release process is. I doubt all the issues 
> currently tagged 4.1 will be closed, since many of them have been moved to 
> next milestones multiple times now.
>
> So, what are the conditions to releasing 4.1? I'm guessing it's only after 
> 4.0.3, but is it immediately after it or something else? Dare I even ask for 
> an updated date? Hah, I do realise that date estimates are doomed to fail.
>
> Many thanks to all the contributors for continually making Sphinx better!
>
> Best regards,
> Felix Hildén
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/17b73c2d-9fe9-43c2-9eaf-43e0b68c83d3n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMcg1usdbm04remxdNx5%3DSdo9eu%3DZ3%2BSgemaH5J2j0s6Q%40mail.gmail.com.

Re: [sphinx-users] Constances in autodoc

[Komiya Takeshi]

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 to document them.
> When I give a constant an all caps name i.e. VERBOSE in a module or class 
> sphinx/autodoc does identify them with bold text name, following the 
> docstring.
> VERBOSE = True
> I would like to add documentation, what it is and how it us used as with 
> variables or  arguments.
>
> Currently I am using :cvar ... to document constants, but that is less than 
> ideal.
> Am I missing something? Others have a better idea?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d3745971-c225-4e94-a853-acfe94b4a11fn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAN33grr31hPZSPUYh6C4DZwsGyyCk6VU_CToYuuJg23uQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 like to manually link directly to the source from 
> several points of the developer guide. Is that possible? If so how? Or is 
> this somehow a bad idea?
>
> I have been browsing docs, stackoverflow and github issues for a while 
> without any luck. I was imagining some custom role like 
> :source:`module.function` or :code:func:`module.function` would be possible.
>
> Best,
> Oriol
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/de3d8b5d-b659-40f7-ba03-b2f82bbf748en%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOx14KDsuZD38izP4bH-MbfMrk99wKi_FDPd_ZC7GzMuQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 -b html -d _build/doctrees  -w 
> warnings.txt . _build/html`
>
> Thanks,
> Anurag
> On Saturday, 29 May 2021 at 10:47:28 UTC-5 i.tk...@gmail.com wrote:
>>
>> 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 
>> > to 4.0.1. When I run the `make docs` on the updated version I get a reST 
>> > markup error: :16: (SEVERE/4) Unexpected section title. Is there a way I 
>> > can find which file has the issue?
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/9cea210d-8649-495d-b094-be0bf61b1a87n%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f9d3b9da-6dc2-408b-9209-10eec65a1cfbn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOK6zTeFKRqH5aVJQ7zGB_LK4N4dm5TUaa%3DD%3D-75FLMZA%40mail.gmail.com.

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

[Komiya Takeshi]

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 when creating autosummary 
> tables, using a metadata tag or something similar?
>
> I'm working on a project with many classes each with a large number of 
> methods. Autosummary has been super helpful to create a summary listing of 
> the methods, but the list is really long so I need a way to separate out the 
> most useful methods from the rest.
>
> Currently I am using this custom template to create the autosummary table for 
> each class:
> https://github.com/bp/resqpy/blob/master/docs/_templates/custom-class-template.rst
>
> I'm wondering if it's possible to break out the Methods section into two 
> parts, "Most useful" and "Others"?
>
> Perhaps this could be controlled by adding a custom metadata tag like :meta 
> important: in the method docstrings, and having two different autosummary 
> tables that somehow only include methods with the relevant tag?
>
> Any tips greatly appreciated!
>
> C
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/cea3c13a-3d86-49ce-acde-7d1d0c8523e7n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM3S5gLo3vwVuK39ivpqG7HPwFtB1sf2BDWbL7%2BQhgqkQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> documentation. It is available at https://asvin.readthedocs.io/en/latest/. 
> Could someone tell me the procedure to include our project in the list 
> mentioned at https://www.sphinx-doc.org/en/master/examples.html .
>
> Best Regards,
> Rohit Bohara
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/b5201457-8381-4314-a93a-79c5c0f54735n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANqSnvvBr_D9VhWR2d6PWU1uj86z0o2J1L-dcy0_QHikQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 to 
> 4.0.1. When I run the `make docs` on the updated version I get a reST markup 
> error: :16: (SEVERE/4) Unexpected section title. Is there a way I can find 
> which file has the issue?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/9cea210d-8649-495d-b094-be0bf61b1a87n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANCvOODPFFyqyQOxstpfjyyW6mjVP7A6JQYvThGB6w5eA%40mail.gmail.com.

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

[Komiya Takeshi]

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 project to a newer 
> releases?  (In the past, we've tended to populate a fresh quickstart 
> template.)
>
> Regards
>
> Ben
>
> On Wednesday, 12 May 2021 at 18:09:00 UTC+1 i.tk...@gmail.com wrote:
>>
>> 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 received a warning from github's dependabot scanning about one of 
>> > the packages upstream from you: underscore.js has a security announcement 
>> > ( CVE-2021-23358 ) for arbitrary code execution. Unfortunately this is 
>> > fixed in underscore 1.12.1, but Sphinx-4.0.1 is still on 1.12.0.
>> >
>> > Regards
>> > Ben
>> >
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/8d539903-4300-4162-afc6-c08a8e741d19n%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/8a049b75-ad1d-4ffc-a7ac-4fcb2bebb0bfn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPekBs4Xx3AA0AxA8vANRopb55i0zJ72uc9nsoQueOPmA%40mail.gmail.com.

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

[Komiya Takeshi]

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 received a warning from github's dependabot scanning about one of 
> the packages upstream from you:  underscore.js has a security announcement ( 
> CVE-2021-23358 ) for arbitrary code execution. Unfortunately this is fixed in 
> underscore 1.12.1, but Sphinx-4.0.1 is still on 1.12.0.
>
> Regards
> Ben
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/8d539903-4300-4162-afc6-c08a8e741d19n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMXPJ2j8R46dfK846CiUYBW3nYw83R8mJDn0MMOex4P8A%40mail.gmail.com.

[sphinx-users] Sphinx-4.0.0 is out

[Komiya Takeshi]

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:
https://github.com/sphinx-doc/sphinx/blob/4.0.x/CHANGES

Thanks to all collaborators and contributers!

What is it?
===

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText source files).

Website: http://sphinx-doc.org/

Enjoy!

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO14yH1o2tOPB0nSyBbvDkiufnE4_hPGk6Y--rrFN%2B6Mg%40mail.gmail.com.

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

[Komiya Takeshi]

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 of the (auto-generated) packages, for 
> example bytes, you can see the entire public API at a glance. From the Sphinx 
> perspective I think this would mean treating directives like ".. func::" and 
> ".. class::" as subheadings that get added to the table of contents. Any 
> pointers? Is this something I could accomplish by modifying our domain code 
> to somehow add ToC entries?
>
> On Friday, January 25, 2019 at 12:53:35 PM UTC-5 johna318 wrote:
>>
>> I’m a sphinx newbie and I’m now moving from autodoc to autosummary.  As of 
>> now I’m pretty confused about the latter.
>>
>>
>> What I want to do is generate html files for each module in a large library 
>> such that each module html file contains a summary table at that lists all 
>> the global variables, functions and classes (including methods etc.) defined 
>> in the file, similarly to what Javadoc does, though probably in a simplified 
>> form.
>>
>>
>> Further, I want to do this at the config and maybe template level, without 
>> having to explicitly list modules or items within modules – same as autodoc 
>> –, so that when I run sphinx-apidoc and sphinx it will find everything it 
>> needs to put in the summaries automatically.  I want this because the 
>> library is constantly evolving as new nodules are added to the library and 
>> new functions and methods are added to the modules.
>>
>>
>> Is this possible?  Or maybe better, how much of what I want can I get?  Also 
>> is there sample code out there that does what I describe or at least 
>> something similar to it.
>>
>>
>> -- John
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d1234af5-aa4f-4a4e-8b5c-da57bf066472n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMrOwoYA6TXUS5p2HLd75uMFpUZ_XMpWkvYNJyEt1RX1w%40mail.gmail.com.

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

[Komiya Takeshi]

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) a remote reference via intersphinx feature. So you don't need to
pass the mapping name to references.
Of course, you can pass the intersphinx-mapping name to the reference
explicitly as you said.

I've never tried to use the Dylan domain, but I believe intersphinx
also supports it.

Thanks,
Takeshi KOMIYA

2021年5月2日(日) 0:03 Carl Gay :
>
> Just noticed this was never answered, so to close the loop...
>
> It turns out I just had the wrong syntax for the references. This works:  
> :func:`http:add-resource`, where "http" is one of the keys in the 
> intersphinx_mapping config and "add-resource" is the name of a function in 
> that document.
>
> On Monday, September 14, 2020 at 2:21:54 PM UTC-4 Carl Gay wrote:
>>
>> Hi, we us Sphinx to document the Dylan language. I would like to use 
>> intersphinx to make it so that any Dylan library documentation can easily 
>> link to any other via :dylan:func:`foo` and similar markup. Someone wrote a 
>> Sphinx domain for Dylan but I'm not super familiar with it (or Sphinx) yet.
>>
>> In this commit I added an intersphinx mapping to our Library Reference docs' 
>> conf.py and then added a test link to index.rst, but Sphinx doesn't find the 
>> xref. To verify that the intersphinx_mapping config is working I also added 
>> the Python mapping and a :py: test link, which works fine.
>>
>> My question is, obviously, why doesn't this work?  But more specifically, 
>> how does Sphinx make the connection from the intersphinx mapping, which uses 
>> the string 'python' to the domain name 'py' in :py:class:`zipfile.ZipFile`?
>>
>> Thanks.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d6520d32-97ea-4a4c-9b0e-bb74eb4f75efn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM2_c-FEq6KaFZy5wxT9bCc_nsoQ5WXLkaFhUO2VcxZvw%40mail.gmail.com.

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

[Komiya Takeshi]

Hi all,

We just released Sphinx-4.0.0b2.
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 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 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 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

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMpHEV3doB-%2BVbtjfR4odQad_qRVV9_QHRXw_th5p5gDA%40mail.gmail.com.

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

[Komiya Takeshi]

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 learning has been through 
> various tutorials. I had few questions which i have not been able to find 
> answers.
>
> Currently, I have a code.rst file where i have few automodules.
>
> ..automodule:: testsphinx
> :members:
>
> ..automodule:: testsphinx1
>   :members:
>
> and so on.
>
> My question is is there a way to automodule all the scripts in the folder? Is 
> there a autofolder? Currently, there are multiple scripts in a folder. At the 
> moment I am manually finding scripts and generating the automodule segment 
> for each. Is there a way to automate it? I am still struggling with this so i 
> havent reached to documenting classes properly but I would assume that i will 
> have to manually write auto-class.
>
> There was also the sphinx-autogen that generates a rst file. I am not 100% 
> sure how that works or if i can use that at the moment.
>
> Any help is appreciated.
> -Sam
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d8a18cac-46ab-4e04-b147-27222b69cd66n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM%2By%2BWmBwVFvjmqSw%3DJoJAOGkNG_CE3%3DCEHVYZetS7HOA%40mail.gmail.com.

[sphinx-users] Call for translation updates

[Komiya Takeshi]

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 team, and translate or
review translations. If your language does not exist, please make a
language request to us. We'll add it ASAP.

We have a plan for releasing sphinx-4.0.0 final in the late of April
(maybe 24-25th).

Thanks,
Takeshi KOMIYA

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMBp5QDNDLFUaek9thUvah62mm2nKJ3cOTDSoFFPE-UEg%40mail.gmail.com.

[sphinx-users] Sphinx-4.0.0b1 released

[Komiya Takeshi]

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 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

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOhcB4iWjh9xED-n%3Ds4NeCz8n%2Bo6Kd5qeJ16ZVg_UyUQQ%40mail.gmail.com.

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

[Komiya Takeshi]

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,
>>
>> 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
>
>
> Many thanks.
>
> Do you happen to know what mechanism I could use to have an image copied at 
> build time from 'images/' to '_build/html/_static/' along with the site logo 
> etc.?
>
> Regards,
>
> Andrew
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/72604eba-a550-4c0d-9cca-4b00996d4549n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPUZiexeHujiC%3Da%2BVDg%2BEX0HtrLpAEvRp5w2p%3D00k1%2BSA%40mail.gmail.com.

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

[Komiya Takeshi]

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 additional images in the 
> sidebar, similar to how readthedocs.io has shown adverts in their sidebar. In 
> may case, two images of the same size as the site logo and aligned to the 
> bottom of the sidebar.
>
> First hurdle was that I can't see how to have these additional images copied 
> from the images/ directory at build time, along with the site logo and 
> favicon. Then I wasn't sure what the best way is to modify the sidebar to 
> include these.
>
> Andrew
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/e50451d1-0833-4cf6-97aa-b3225e1e688fn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOFoiOME7B8_OgBrKLVUKn_XC3tcr9vrO2On01XjMt_eg%40mail.gmail.com.

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

[Komiya Takeshi]

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 Evans :
>
> Hello,
>
> We have a codebase mainly containing user-facing documentation for a set of 
> command line tools, but which also contains a smaller section of developer 
> API documentation.
>
> When searching the documentation for information on a tool, Sphinx often 
> ranks several results for developer API above the user-facing documentation, 
> which rather annoys users.
>
> Is there a reasonably simple way to prevent the developer documentation pages 
> (which are contained in a single directory) from being listed in search 
> results? Is there some configuration option like "'search_ignore': 
> 'developer/*'"?
>
> (An obvious alternative is to have two separate sets of documentation, 
> perhaps with intersphinx links, given the two fairly separate use cases)
>
> Regards,
> Daniel
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/ca06082a-010c-44f1-8f2b-c2dece4380ecn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM4hrxGLCcbbqMVc2ezVp-evCWmzfQYD76g3vgK910eBQ%40mail.gmail.com.

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

[Komiya Takeshi]

>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

2021年4月5日(月) 3:29 Vladimír Marek :
>
> Ahaa
> I did not know that the content is specified by indentation, thanks for
> explanation!
> I tried that and works OK!
>
> Just one more question. The table directive adds a caption "Table 1" ...
> "Table 1 – continued from previous page" which is misleading in my case.
> I have many other tables in my doc (but they are not specified by table
> directive).
> Is it possible to either rename this label or remove it completely?
>
> >> 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 directive could not find any
> > content.
> >
> >> Could you please give me an example?
> > Here.
> >
> > .. table:: Truth table for "not"
> > :class: longtable
> >
> > =  =
> >   Anot A
> > =  =
> > False  True
> > True   False
> > =  =
> >
> > 2021年4月4日(日) 4:41 VlaMa :
> >> Hi,
> >>
> >> I read about that but most likely I did not understand it well. I thought 
> >> that the content is a table itself ...
> >> What should I write there as a "table mark-up content"? Could you please 
> >> give me an example?
> >>
> >> Thanks!
> >>
> >> On Saturday, April 3, 2021 at 9:36:10 AM UTC+2 i.tk...@gmail.com wrote:
> >>> 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 :
>  Hello,
> 
>  I have a table which is generated across one pdf page and rest of it is 
>  hidden (it is not
>  shown on second page). I found out I should be able to use
> 
>  .. table::
>  :class: longtable
> 
>  and that should break the table in my pdf output. However this does not 
>  work for me and
>  the table is still rendered incorrectly.
>  During document compilation there is following warning:
>  WARNING: Content block expected for the "table" directive; none found.
> 
>  Unfortunately I did not figured out what that means and I don't know how 
>  to fix it. Is it
>  possible this warning causing the issue that table is not well formatted?
> 
>  Any tips are appreciated.
> 
>  Thanks!
> 
>  --
>  You received this message because you are subscribed to the Google 
>  Groups "sphinx-users" group.
>  To unsubscribe from this group and stop receiving emails from it, send 
>  an email to sphinx-users...@googlegroups.com.
>  To view this discussion on the web visit 
>  https://groups.google.com/d/msgid/sphinx-users/43b01acb-8c98-4904-a9bf-286ba0a867fbn%40googlegroups.com.
> >> --
> >> You received this message because you are subscribed to the Google Groups 
> >> "sphinx-users" group.
> >> To unsubscribe from this group and stop receiving emails from it, send an 
> >> email to sphinx-users+unsubscr...@googlegroups.com.
> >> To view this discussion on the web visit 
> >> https://groups.google.com/d/msgid/sphinx-users/b9704311-3019-4aac-be5a-2bb06b58c4ean%40googlegroups.com.
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/7c664f81-baa6-f4d5-de82-5540854c4306%40frafos.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANp1SY-E-z_n8soKzc%3DQCn6PL5dMD-pfS0HatE5U5c-Og%40mail.gmail.com.

Re: [sphinx-users] Indexing static HTML files

[Komiya Takeshi]

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 
> indexed for search, and returned in search results?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/fa8d93e4-c090-4f1e-9f7f-2658417c9a95n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPCLznCB8oYo8Vrzf7Rwj%2BmufL-rZYJMzrmZS-EWsufwA%40mail.gmail.com.

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

[Komiya Takeshi]

>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 directive could not find any
content.

>Could you please give me an example?

Here.

.. table:: Truth table for "not"
   :class: longtable

   =  =
 Anot A
   =  =
   False  True
   True   False
   =  =

2021年4月4日(日) 4:41 VlaMa :
>
> Hi,
>
> I read about that but most likely I did not understand it well. I thought 
> that the content is a table itself ...
> What should I write there as a "table mark-up content"? Could you please give 
> me an example?
>
> Thanks!
>
> On Saturday, April 3, 2021 at 9:36:10 AM UTC+2 i.tk...@gmail.com wrote:
>>
>> 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 :
>> >
>> > Hello,
>> >
>> > I have a table which is generated across one pdf page and rest of it is 
>> > hidden (it is not
>> > shown on second page). I found out I should be able to use
>> >
>> > .. table::
>> > :class: longtable
>> >
>> > and that should break the table in my pdf output. However this does not 
>> > work for me and
>> > the table is still rendered incorrectly.
>> > During document compilation there is following warning:
>> > WARNING: Content block expected for the "table" directive; none found.
>> >
>> > Unfortunately I did not figured out what that means and I don't know how 
>> > to fix it. Is it
>> > possible this warning causing the issue that table is not well formatted?
>> >
>> > Any tips are appreciated.
>> >
>> > Thanks!
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/43b01acb-8c98-4904-a9bf-286ba0a867fbn%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/b9704311-3019-4aac-be5a-2bb06b58c4ean%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMDLcEDgFiNjhjHb%3DzaSyRhGdQgZAz%2BhRLB71HP5p9iGA%40mail.gmail.com.

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

[Komiya Takeshi]

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 :
>
> Hello,
>
> I have a table which is generated across one pdf page and rest of it is 
> hidden (it is not
> shown on second page). I found out I should be able to use
>
> .. table::
>   :class: longtable
>
> and that should break the table in my pdf output. However this does not work 
> for me and
> the table is still rendered incorrectly.
> During document compilation there is following warning:
> WARNING: Content block expected for the "table" directive; none found.
>
> Unfortunately I did not figured out what that means and I don't know how to 
> fix it. Is it
> possible this warning causing the issue that table is not well formatted?
>
> Any tips are appreciated.
>
> Thanks!
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/43b01acb-8c98-4904-a9bf-286ba0a867fbn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPzx1YSU6gpQegSE8g3joSChe5GPvJVoi3VAhTtGCE_tQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> following issues have appeared and images cannot be parsed:
> WARNING: image file not readable: assets/images/Server/Tasks/trashIcon.png
>
> In the .rst file, the path for an image is specified as 
> ../../assets/images/Server/Tasks/trashIcon.png
>
> The path to a file is correct and when I compile this project on other 
> machines (Ubuntu/Windows 10) compilation succeeds and no warnings appear 
> (images are present in html output).
>
> I found that compilation also succeeds when I specify the path as absolute 
> i.e. /../assets/images/Server/Probe.Page/trashIcon.png
>
> Sphinx documentation says that relative paths are available for the image 
> directive.
> But I cannot define what's wrong with a relative path in my case on this 
> machine? May I wrongly understand the point of relative paths? What's the 
> correct way of specifying path for image directives?
>
> My environment is:
> Python 3.9.2
> Sphinx v3.5.2
>
> NB: OFC I may convert all the paths to absolute, but there are lots of images 
> and I should ensure that this is required because I wrongly specify path all 
> this time before.
>
> Thanks in advance!
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/e3f214fe-9894-4da6-9839-1fa9d1094793n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPXp3hgzSBHpEs8D0-OVtG_URVuhOY%2BmaTtKHv1QDUakg%40mail.gmail.com.

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

[Komiya Takeshi]

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.
>
> My understanding was that I'd need to double the backslashes as follows in my 
> reStructuredText: volume\\folder\\
>
> Doing that works correctly for the backslashes before and after "folder" but 
> the 4 backslashes before "volume" are still displayed as a single backslash 
> in my output: \volume\folder\
>
> Can anyone advise how to display the double backslashes before "volume" so my 
> output correctly displays \volume\folder?
>
> Thanks in advance!
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/651a3c96-e4c4-4005-9c88-8f2ce9d1c7f7n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPFdxE9xEaCHcehywa%3D4ov88rc%2BUYrffx9qiEfyZ0qPvA%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> list of different representations of an object, include the one that is best 
> suited to a specific sphinx builder.
>
> Because I want to choose the highest priority node out of a list, the 
> decision cannot be made by examining a single sphinx node. My proposed 
> solution is drafted here. Implement a MimeBundleNode, which modifies the walk 
> and walkabout methods of a node to "pretend" only contained the highest 
> priority child.
>
> While it seems to work™, not being closely familiar with sphinx, I have an 
> uneasy feeling that I'm doing something that I'm not supposed to do. Is there 
> some subtlety that I overlook? Is there a better implementation?
>
> Thanks in advance,
> Anton
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/8ef55217-88a1-4af3-8d36-fd7d0a4bcb79n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOhhvRv1dNT74s47%3Dr4R-5gbMgOveHWcwBRynCwnYP0Sw%40mail.gmail.com.

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

[Komiya Takeshi]

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 situation that is exactly defined in this issue at stackoverflow
> https://stackoverflow.com/questions/39717529/duplicate-implicit-target-name-how-to-use-a-subtitle-name-more-than-once/39720161
>
> Is there a support for something like the above? Is something like this 
> supported in Sphinx?
>
> This seems like  common scenario, with section names like Description, 
> Details and so on when you have them in an over arching documentation like 
> features, chapters and so on
>
> Ascii doctor has support for something like this through attribute groups 
> property
> https://asciidoctor.org/docs/asciidoc-recommended-practices/#attribute-groups
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/af43e19e-ad4e-43d5-bd7c-d89796041fb7n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMYb%2BPrp%2BEtsgC%2BXSB%2BKBS%2B-HQGz6MzjRkZAm30vEhWwQ%40mail.gmail.com.

Re: [sphinx-users] Conditional images

[Komiya Takeshi]

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.

Thanks,
Takeshi KOMIYA

2021年2月25日(木) 12:27 'William Abernathy' via sphinx-users <
sphinx-users@googlegroups.com>:

> I have a product with a "split personality." I want the documentation to
> provide one diagram (with "product A" in the diagram) for when I am
> generating documentation for product A and a different diagram (with
> "product B" in the image) for when I am generating documentation for
> product B. I have two such images.
>
> I have established that I cannot include a substitution in an .. image::
> declaration. It appears that our .. only:: declaration is already
> occupied with html-vs.-pdf outputs. I have been experimenting fruitlessly
> with .. ifconfig:: declarations, which give me a lot of this warning:
>
> Warning, treated as error:
> /home/docs/docsource/operation/Architecture/index.rst:14:Exception occured
> in ifconfig expression:
>   File "", line 2
> .. image:: ../Graphics/product_A_hi-level_2.0.*
>
> I am not sufficiently skilled to build an extension to resolve this. Is
> there an easy or obvious way to make this work? (I believe we're still on
> Sphinx 1.8.3 in a containerized build environment)
>
> Thanks,
> --
>
>
> William Abernathy
>
> Sr. Tech Writer
>
> San Francisco
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/sphinx-users/CAHz33vWZ5hx%3DxYeQm37vJpjF6cweNmE0fooe8%2Bq4yGMYeAzYfw%40mail.gmail.com
> 
> .
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPRbvmiswN%2BxevA4jrmtwwJfrag2JZw0fqOTYUxf97%3DAg%40mail.gmail.com.

Re: [sphinx-users] Apostrophes

[Komiya Takeshi]

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 Daniele Zambelli :
>
> Hello!
>
> When a word ends with an apostrophe in my source, I get a double
> quotation mark in the pdf:
>
> source: ... po' ...
>
> result: ... po" ...
>
> po" is wrong!
>
> How can I correct it?
>
> Thank you.
>
> --
>
> Daniele
>
> www.fugamatematica.blogspot.com
>
> giusto!
> nel verso
> forse è perché non guardiamo le cose
> Quando non ci capiamo,
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/CAE512rNgLNH1n8YDzViSrKYkDCpeOEbg9NogoF1RzHw709rSTQ%40mail.gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMSXQCrj1FoW_SBZcwWCL63ocA%3DW4AkwRRn8E_kxL2bYA%40mail.gmail.com.

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

[Komiya Takeshi]

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? Sometimes pages are moved/renamed and I would like to detect 
> when a cross reference gets broken. I imagine that this check could be done 
> during documentation building or as pytest test case.
>
> Best regards,
> Albertas Gimbutas
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/0270f40d-0e99-4b96-aca8-dd68312dd657n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPtycH3bxugd7_jBYq_2gZYFW%2Bt81mh7en7dLH-P%3DOrgA%40mail.gmail.com.

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

[Komiya Takeshi]

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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPWn7BSwLEd%3DD%3DuWX%2BmYAiVBok7wHVVJAb9%2Bij0gZYERA%40mail.gmail.com.

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

[Komiya Takeshi]

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 annotations that are imported from internal 
> modules. This occurs for projects that put actual implementations in internal 
> modules, and only let public modules import necessary symbols.
>
> For example, the pytest project has its implementation in _pytest subpackage: 
> https://github.com/pytest-dev/pytest/tree/master/src/_pytest
>
> And it imports public symbols from pytest/__init__.py: 
> https://github.com/pytest-dev/pytest/blob/master/src/pytest/__init__.py
>
> However, the type annotation in the document seems pretty messed. For 
> example, in the doc of pytest.Function [1], one of the base classes is 
> documented as "_pytest.nodes.Item". But this object is imported from 
> pytest/__init__.py [2], and the base class should be documented as 
> "pytest.Item" instead of "_pytest.nodes.Item".
>
> I understand autodoc_type_aliases may help, but I would like to ask whether 
> there's a more generic and consistent way to handle all these situations.
>
> Thanks!
> Hong
>
> [1]: https://docs.pytest.org/en/stable/reference.html#pytest.Function
> [2]: 
> https://github.com/pytest-dev/pytest/blob/6a5d47a243d2ddbf92fca5e807cf1324d60cabb1/src/pytest/__init__.py#L32
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f9d14454-a116-4b6a-bfae-5ba440426c04n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPRnNbJgv5NY%3DVVPFcPz9yhodH8LqOfX-55qw%2Bp6%3DhC2A%40mail.gmail.com.

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

[Komiya Takeshi]

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 the upgrade I 
> cannot build my Sphinx project. When I do make html I get the following error:
>
> Running Sphinx v1.8.5
> loading translations [es]... done
>
> Extension error:
> Could not import extension sphinx.builders.linkcheck (exception: No module 
> named requests.exceptions)
> Makefile:19: recipe for target 'html' failed
> make: *** [html] Error 2
>
> How could I fix it?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f1fa3017-d835-421e-9399-62837e35577dn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANfaYOSyJE_XLLr-zb_-MTnX1c4ShL-d6QwpwwKdqbVZg%40mail.gmail.com.

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

[Komiya Takeshi]

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 system and now sphinx is being called from a python
> script.  That parts looks like this:
>
> from sphinx.ext.apidoc import main as apidoc_main
> ...
> apidoc_main(['-q', '-f', '-e', '-M', '--implicit-namespaces', '-o', 'modules',
>  os.path.join('..', 'devkit'),
>  os.path.join('..', 'devkit', 'tests')])
>
> It generates the API rsts, BUT it doesn't call setup() in conf.py, as
> evidenced by a print statement I put in there. sphinx-build does call setup.py
> when called in a similar manner.
>
> What is the best way to debug why setup.py isn't being called by sphinx-
> apidoc?
>
> j
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/3753498.taCxCBeP46%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMi0vHbgP%2BbLsvCO25WHQ-%3Dwutw6ctyr%2BpzCJE_rHOtnQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 `templates_path` configuration contains above template dir
4. Set up your custom sidebar via `html_sidebars`

Thanks,
Takeshi KOMIYA

2021年1月17日(日) 20:23 Oscar Benjamin :
>
> Hi,
>
> Is there a simple way to tell Sphinx to add some links to the sidebar
> in the HTML output for the classic theme?
>
> I'm trying to migrate the SymPy doc build from Travis to Actions and
> I'm wondering if there's a better way of adding sidebar links.
>
> You can see the sidebar links here:
> https://docs.sympy.org/latest/index.html
>
> In particular it has:
>
> Documentation version
> SymPy 1.7.1 (latest release)
> SymPy 1.8.dev (development version)
>
> At the moment those links are added by post-processing the HTML output
> from Sphinx using this script which also does some other redundant
> things that are no longer needed:
> https://github.com/sympy/sympy_doc/blob/gh-pages/generate_indexes.py
>
> Related sympy issue:
> https://github.com/sympy/sympy_doc/issues/46
>
> I think it would be cleaner if we could tell Sphinx to add those links
> and avoid any post-processing of the output from Sphinx but I'm not
> sure how to do it...
>
> Oscar
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/CAHVvXxRkkNfFT9twcVV%3DzB51zbOX2OmM_j9Dp6MkxE6To23vVw%40mail.gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANgyxGfR61MX1Lyj0uvLO-_RQALG0boX%2Bcz_95XYcE-YQ%40mail.gmail.com.

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

[Komiya Takeshi]

I suppose `latex_engine = 'uplatex'` setting will help your case. It
can compile the LaTeX document including some unicode characters
especially Japenese. Please try it if you have time.

Thanks,
Takeshi KOMIYA

2021年1月6日(水) 16:05 藤田祐治 :
>
> Komiya-san,
>
> Thank you very much and sorry 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 :
>>
>> 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 "substituted" document.
>>
>> Thanks,
>> Takeshi KOMIYA
>>
>> 2020年12月20日(日) 12:43 藤田祐治 :
>> >
>> > Hi
>> > Addition.
>> > In my case
>> > make -e SPHINXOPTS="-D language='ja'" html
>> >
>> > does not reflect rst_elpilog
>> >
>> > However
>> > make -e SPHINXOPTS="-D language='ja'" latexpdf
>> >
>> > reflect rst_epilog
>> >
>> > anything wrong with my set up?
>> >
>> > Thanks
>> > Yuji
>> >
>> >
>> >
>> >
>> > 2020年12月20日日曜日 11:40:20 UTC+9 藤田祐治:
>> >>
>> >> Hi
>> >> I am using Sphinx and Sphinx-intl for the document translation from 
>> >> Englsih to Japanese.
>> >>
>> >> After translating to Japanese in PO file and then, run
>> >> make -e SPHINXOPTS="-D language='ja'" html
>> >>
>> >> All translation is reflected in html file in Japanese.
>> >> However,  I can not reflect rst-epilog
>> >>
>> >> Here is rst-epilog in conf.py file:
>> >>
>> >> rst_epilog = """
>> >> ..  |variable_version| replace:: 2.5
>> >> """
>> >>
>> >> This is supposed to replace |variable_version| with version number of 2.5
>> >> It looks rst_epilog is not working in my case.
>> >> I mean converted html still remain |variable_version|
>> >>
>> >> How can I make rst_epilog work,?
>> >>
>> >> Thanks
>> >> Yuji
>> >>
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users+unsubscr...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/4679212d-f026-4af2-8526-ac8163361534n%40googlegroups.com.
>>
>> --
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx-users+unsubscr...@googlegroups.com.
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOyA8AYw4D_PX6yWg6Pwm65AF4MYSkOgNKwRMUfm8SZnw%40mail.gmail.com.
>
>
>
> --
> 藤田　祐治
> オープンリンク株式会社
> 代表取締役　社長
> 住所：千葉県千葉市美浜区打瀬2-9-16-414
> 携帯：080-3694-5550
> e-mail: yujfuj...@open-lc.co.jp
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/CABdx1LvSQv1Q8nN_Z1w03q19zLSujB0Dc%2BcmfhQL-eyFSVnWkA%40mail.gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAP7X-WDs40PpO0ffr-C1_Qv%2Bev7k6XFzJLPCmo-DiAEAw%40mail.gmail.com.

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

[Komiya Takeshi]

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,
>
> 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,
> >
> > 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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM5V53TVfR7fAeRdULWWU1jYwbcVX5ku5fcnBhv92adxw%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> formatting errors from what I think is the `dict` docstring rather than my 
> code. I have a module (`node`) which contains a dict:
>
> #: Colour map to use when writing Invoke schedule to terminal.
> SCHEDULE_COLOUR_MAP = {"Schedule": "white",
>"Loop": "red",
>"GlobalSum": "cyan"}
>
> This module is then made available in the __all__ list of the __init__.py of 
> the package
> containing the module, i.e. I have an __init__.py that contains:
>
> from nodes.node import SCHEDULE_COLOUR_MAP
> __all__ = ['SCHEDULE_COLOUR_MAP']
>
> When running Sphinx autodoc I see:
>
> /blah blah/nodes/__init__.py:docstring of 
> psyclone.psyir.nodes.SCHEDULE_COLOUR_MAP:3: WARNING: Unexpected indentation.
> /blah blah/nodes/__init__.py:docstring of 
> psyclone.psyir.nodes.SCHEDULE_COLOUR_MAP:4: WARNING: Block quote ends without 
> a blank line; unexpected unindent.
> /blah blah/nodes/__init__.py:docstring of 
> psyclone.psyir.nodes.SCHEDULE_COLOUR_MAP:7: WARNING: Unexpected indentation.
> /blah blah/psyir/nodes/__init__.py:docstring of 
> psyclone.psyir.nodes.SCHEDULE_COLOUR_MAP:9: WARNING: Inline strong 
> start-string without end-string.
>
> As you can see, I've tried explicitly adding a docstring for the dict using 
> the `#:` markup but that doesn't seem to get picked up.
>
> I get exactly the same problem with a different dictionary in a different 
> module.
>
> Am I doing something wrong here?
>
> (FYI, you can reproduce this problem by cloning 
> https://github.com/stfc/PSyclone.git, cd PSyclone; pip install .; cd 
> doc/reference_guide; make html)
>
> Many thanks,
>
> Andy.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/d845e746-db09-4712-ad82-058d34d591efn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANCin4KF%3DT4AkF3XayFHUCnKSFSZYYmxuT%2Bbja2sQ7MVA%40mail.gmail.com.

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

[Komiya Takeshi]

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 receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPjjg0GWEpcs7L1aU7c9DFyMa3%2BVAzusnfQ2UZO50NTDA%40mail.gmail.com.

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

[Komiya Takeshi]

Hi,

It seems your document uses "automodule" directive to document for
tensorgraph.models_zoo.echocardiac.dilated_unet.model. It generates
docs from the installed module. So I guess the difference you said
came from the absence of the tensorgraph module. What I meant is check
the tensorgraph 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写道：
>>
>> 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,
>> Takeshi KOMIYA
>>
>> 2020年12月9日(水) 13:14 haojie shu :
>> >
>> > Hello everyone，today I met a problem. I found I have the same rst file 
>> > on my mac and on my ubuntu. But after make html, I  found the html have 
>> > big difference. Below is the rst file. I don't know why, anyone help me?
>> >
>> >
>> > dilated_unet
>> > =
>> >
>> > --
>> >
>> > model
>> > --
>> >
>> > .. automodule:: tensorgraph.models_zoo.echocardiac.dilated_unet.model
>> >:members:
>> >:undoc-members:
>> >:show-inheritance:
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users+unsubscr...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/97bac378-9294-402d-8316-358b3516b2d1n%40googlegroups.com.
>>
>> --
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx-users+unsubscr...@googlegroups.com.
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPwkW9Mrn1KkO4CyS9o2EfbOS6TT%2B839-wFNf1ZkADrLQ%40mail.gmail.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/CAG_%2Brw%2BYb28dSHE3PEbaBO-hMXk9paWSpFDjUbcKHS-Tu2ja5g%40mail.gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANy%2B-0Azk6YvWpkYLFDj3jB8zUoVHpgvao3X7BRmut0ew%40mail.gmail.com.

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

[Komiya Takeshi]

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 "substituted" document.

Thanks,
Takeshi KOMIYA

2020年12月20日(日) 12:43 藤田祐治 :
>
> Hi
> Addition.
> In my case
> make -e SPHINXOPTS="-D language='ja'" html
>
> does not reflect rst_elpilog
>
> However
> make -e SPHINXOPTS="-D language='ja'" latexpdf
>
> reflect rst_epilog
>
> anything wrong with my set up?
>
> Thanks
> Yuji
>
>
>
>
> 2020年12月20日日曜日 11:40:20 UTC+9 藤田祐治:
>>
>> Hi
>> I am using Sphinx and Sphinx-intl for the document translation from Englsih 
>> to Japanese.
>>
>> After translating to Japanese in PO file and then, run
>> make -e SPHINXOPTS="-D language='ja'" html
>>
>> All translation is reflected in html file in Japanese.
>> However,  I can not reflect rst-epilog
>>
>> Here is rst-epilog in conf.py file:
>>
>> rst_epilog = """
>> ..  |variable_version| replace:: 2.5
>> """
>>
>> This is supposed to replace |variable_version| with version number of 2.5
>> It looks rst_epilog is not working in my case.
>> I mean converted html still remain |variable_version|
>>
>> How can I make rst_epilog work,?
>>
>> Thanks
>> Yuji
>>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/4679212d-f026-4af2-8526-ac8163361534n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOyA8AYw4D_PX6yWg6Pwm65AF4MYSkOgNKwRMUfm8SZnw%40mail.gmail.com.

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

[Komiya Takeshi]

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,
>
> 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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOQaUbzGUFzhk_Hu8gUT5Z%2BOHM5udhV-r8-vJpVxCP%2BUQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 rendered as images,
> preferably as SVG ones.
>
> I'm aware of the sphinx.ext.imgmath extension that renders math via
> LaTeX and dvisvgm into SVG images.
>
> But could this be extended to other content than (exclusively) math,
> just as dvisvgm can do, as shown by:
>
> --8<---cut here---start->8---
> pdflatex <<< "\documentclass{article}
> \usepackage{lmodern}
> \begin{document}
> \section{Test}
> This a \emph{test} for \textsf{dvisvgm}!
> \end{document}" && dvisvgm --pdf texput.pdf && xdg-open test.svg
> --8<---cut here---end--->8---
>
> Thanks for any help on this subject.
> --
> Denis
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/87zh25pjpi.fsf%40example.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANKk9zc39Gbju4B6Lu3%2BUq_wQ9itEhfig%3DPLyo7oxW2rA%40mail.gmail.com.

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

[Komiya Takeshi]

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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPappo6CR-3zoTt9%3DFmc7%2BpJx5qW7GAiKjtYdYn7Ci2kQ%40mail.gmail.com.

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

[Komiya Takeshi]

I guess you used pending_xref nodes after the reading phase. They are
generated during the reading phase and converted into the reference
nodes on the resolving phase. As a result, writer components don't
handle them.

Thanks,
Takeshi KOMIYA

2020年12月12日(土) 23:26 Nic30original :
>
> Nice, that was the answer what I was hoping for.
> I tried it before, but I did it in Element visit_html which resulted in
>
> ```
> Exception occurred:
>File
> "/usr/local/lib/python3.8/dist-packages/sphinx/writers/html5.py", line
> 793, in unknown_visit
>  raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
> NotImplementedError: Unknown node: pending_xref
> ```
>
> If I use pending_xref in Directive it works.
>
> https://github.com/Nic30/sphinx-hwt/commit/ba360c63f91d776cc07962021d3368b60dd405c7#diff-6369c7879f44cbaf51bfd17223507b52dfed6646cefcac2bacd89bba46a2070bR197
> <https://github.com/Nic30/sphinx-hwt/commit/ba360c63f91d776cc07962021d3368b60dd405c7#diff-6369c7879f44cbaf51bfd17223507b52dfed6646cefcac2bacd89bba46a2070bR197>
>
> You can see the result on
> 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 wrote:
> > Hi,
> >
> > Bingo! Sphinx uses the pending_xref nodes to realize the
> > cross-reference feature.
> >
> > Please try to make a node that refers python class like this:
> >
> > ```
> > node = sphinx.addnodes.pending_xref(refdomain='py', reftype='class',
> > reftarget='stringio.StringIO')
> > node += nodes.Text('stringio.StringIO)
> > ```
> >
> > The pending_xref node should have three attributes:
> >
> > * refdomain: domain of the reference. For python objects, please set 'py'.
> > * reftype: type of the python object.
> > * reftarget: name of the python object.
> >
> > All you should do is only generating pending_xref node. It will be
> > converted to a cross-reference automatically on the latter step of
> > Sphinx.
> > Please try this in your code.
> >
> > Thanks,
> > Takeshi KOMIYA
> >
> > 2020年12月10日(木) 5:54 Nic30 :
> >>
> >> Basicaly I am trying to generate reference element to a class.
> >>
> >> I am able to get a class object in `Directive.run()` which I want to 
> >> reference in documentation.
> >> Currently I am using `sphinx.util.typing.stringify` to get a string and 
> >> then returning `docutils.nodes.Text`
> >>
> >> I would like to create href in html documentation which redirects the 
> >> browser to the type definition.
> >>
> >> I guess I should use 
> >> https://www.sphinx-doc.org/en/master/extdev/nodes.html#sphinx.addnodes.pending_xref
> >>
> >> But I am not sure how or if it is a good idea. I can always craft the link 
> >> manually as shown in 
> >> https://www.sphinx-doc.org/en/master/development/tutorials/todo.html
> >> Is there a better way?
> >>
> >> I guess that the apidoc or other extensions needs to have function just 
> >> for this but I just can't see it.
> >>
> >> Any hit appreciated.
> >>
> >> https://github.com/Nic30/sphinx-hwt/blob/master/sphinx_hwt/directive_params.py#L80
> >>
> >> --
> >> You received this message because you are subscribed to the Google Groups 
> >> "sphinx-users" group.
> >> To unsubscribe from this group and stop receiving emails from it, send an 
> >> email to sphinx-users+unsubscr...@googlegroups.com.
> >> To view this discussion on the web visit 
> >> https://groups.google.com/d/msgid/sphinx-users/f5079d3e-14c5-4966-b33f-d7bc94973b98n%40googlegroups.com.
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/4924cb01-25c3-84db-ba4e-9e6a50346e6a%40gmail.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOqbEKBDZP7k7GPGGbfE747s_UGDp_V%3D_yGY1wOHGjqNw%40mail.gmail.com.

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

[Komiya Takeshi]

Hi,

Bingo! Sphinx uses the pending_xref nodes to realize the
cross-reference feature.

Please try to make a node that refers python class like this:

```
node = sphinx.addnodes.pending_xref(refdomain='py', reftype='class',
reftarget='stringio.StringIO')
node += nodes.Text('stringio.StringIO)
```

The pending_xref node should have three attributes:

* refdomain: domain of the reference. For python objects, please set 'py'.
* reftype: type of the python object.
* reftarget: name of the python object.

All you should do is only generating pending_xref node. It will be
converted to a cross-reference automatically on the latter step of
Sphinx.
Please try this in your code.

Thanks,
Takeshi KOMIYA

2020年12月10日(木) 5:54 Nic30 :
>
>
> Basicaly I am trying to generate reference element to a class.
>
> I am able to get a class object in `Directive.run()` which I want to 
> reference in documentation.
> Currently I am using `sphinx.util.typing.stringify` to get a string and then 
> returning `docutils.nodes.Text`
>
> I would like to create href in html documentation which redirects the browser 
> to the type definition.
>
> I guess I should use 
> https://www.sphinx-doc.org/en/master/extdev/nodes.html#sphinx.addnodes.pending_xref
>
> But I am not sure how or if it is a good idea. I can always craft the link 
> manually as shown in 
> https://www.sphinx-doc.org/en/master/development/tutorials/todo.html
> Is there a better way?
>
> I guess that the apidoc or other extensions needs to have function just for 
> this but I just can't see it.
>
> Any hit appreciated.
>
> https://github.com/Nic30/sphinx-hwt/blob/master/sphinx_hwt/directive_params.py#L80
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/f5079d3e-14c5-4966-b33f-d7bc94973b98n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMb-SrNG7LhwvY0h%3Dk-RxLuF_FUwrY8mequSJw18ZafDg%40mail.gmail.com.

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

[Komiya Takeshi]

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
```

```
# subfoloder1/foo1.rst

This a title


.. toctree::

   subfoloder2/foo2
```

Then you'll see a ToC tree as expected.

Thanks,
Takeshi KOMIYA

2020年12月2日(水) 5:08 Denis Bitouzé :
>
>
> Hi,
>
> Suppose I have:
>
> - a `foo0.rst` file at the root (`source`) of my `sphinx-doc` source folder,
> - a `foo1.rst` file in a subfolder `subfolder1` of `source`,
> - a `foo2.rst` file in a subfolder `subfolder2` of `subfolder1`,
>
> that is:
>
>   ┌
>   │ $ tree source
>   │ source
>   │ ├── foo0.rst
>   │ └── subfolder1
>   │ ├── foo1.rst
>   │ └── subfolder2
>   │ └── foo2.rst
>   └
>
> all with the same content:
>
>   ┌
>   │ This a title
>   │ 
>   └
>
> Now, if the `index.rst` contains:
>
>   ┌
>   │ Welcome to Test's documentation!
>   │ 
>   │
>   │ .. toctree::
>   │:maxdepth: 3
>   │:caption: Contents:
>   │
>   │foo0
>   │subfolder1/foo1
>   │subfolder1/subfolder2/foo2
>   └
>
> `make html` gives:
>
>   ┌
>   │ Welcome to Test’s documentation!
>   │
>   │ Contents:
>   │
>   │ • This a title
>   │ • This a title
>   │ • This a title
>   └
>
> that is all the headings are sections.
>
> What I would like to get instead is the following:
>
>   ┌
>   │ Welcome to Test’s documentation!
>   │
>   │ Contents:
>   │
>   │ • This a title
>   │   ◦ This a title
>   │ ▪ This a title
>   └
>
> that is the heading of:
>
> - `foo0.rst` being a section,
> - `subfolder1/foo1.rst` being a subsection (and not a section),
> - `subfolder1/subfolder2/foo2.rst` being a subsubsection (and not
>   a section).
>
> My question is therefore: is it possible to make the heading levels of
> documents belonging to (sub(sub(...)))folders automatically depending on
> the depth's levels of the folders they belong to?
>
> Thanks.
> --
> Denis
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/3e00313f-3985-48b6-9c09-592daa0922b6n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM1hqEO-gW%3DK5jTA3a%3DffiYkurmtjDivPPexe89-Pvh9g%40mail.gmail.com.

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

[Komiya Takeshi]

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,
Takeshi KOMIYA

2020年12月9日(水) 13:14 haojie shu :
>
> Hello everyone，today I met a problem. I found I have the same rst file on 
> my mac and on my ubuntu. But after make html, I  found the html have big 
> difference. Below is the rst file. I don't know why, anyone help me?
>
>
> dilated_unet
> =
>
> --
>
> model
> --
>
> .. automodule:: tensorgraph.models_zoo.echocardiac.dilated_unet.model
>:members:
>:undoc-members:
>:show-inheritance:
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/97bac378-9294-402d-8316-358b3516b2d1n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPwkW9Mrn1KkO4CyS9o2EfbOS6TT%2B839-wFNf1ZkADrLQ%40mail.gmail.com.

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

[Komiya Takeshi]

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:
>
> - at the end of my `conf.py` file:
>
> --8<---cut here---start->8---
> rst_prolog = """
> .. role:: LaTeXLogo
> """
> --8<---cut here---end--->8---
>
> - in some of my `.rst` files:
>
> --8<---cut here---start->8---
> :LaTeXLogo:`LaTeX`
> --8<---cut here---end--->8---
>
> But this doesn't work since `make html` retrains:
>
>   ┌
>   │ WARNING: Unknown interpreted text role "LaTeXLogo".
>   └
>
> Am I missing something?
>
> Thanks!
> --
> Denis
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/87wnxofgu9.fsf%40example.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOna57F_5C-%2Be19OXSR%3DpZWPQm%3DtbKGjN8-aB3QSvcpqw%40mail.gmail.com.

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

[Komiya Takeshi]

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 Nazir :
>
>
> Something wrong with sphinxcontrib-katex?
>
>
> # Loaded extensions:
> # sphinx.ext.mathjax (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/mathjax.py
> # sphinxcontrib.applehelp (1.0.1) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/applehelp/__init__.py
> # sphinxcontrib.devhelp (1.0.1) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/devhelp/__init__.py
> # sphinxcontrib.htmlhelp (1.0.2) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/htmlhelp/__init__.py
> # sphinxcontrib.serializinghtml (1.1.3) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/serializinghtml/__init__.py
> # sphinxcontrib.qthelp (1.0.2) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/qthelp/__init__.py
> # alabaster (0.7.12) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/alabaster/__init__.py
> # sphinx.ext.autodoc (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/autodoc/__init__.py
> # sphinx.ext.autosummary (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/autosummary/__init__.py
> # sphinx.ext.doctest (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/doctest.py
> # sphinx.ext.intersphinx (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/intersphinx.py
> # sphinx.ext.todo (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/todo.py
> # sphinx.ext.coverage (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/coverage.py
> # sphinx.ext.napoleon (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/napoleon/__init__.py
> # sphinx.ext.viewcode (2.2.0) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/ext/viewcode.py
> # sphinxcontrib.katex (0.6.1) from 
> /home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/katex.py
> Traceback (most recent call last):
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/cmd/build.py", 
> line 276, in build_main
> app.build(args.force_all, filenames)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/application.py", 
> line 346, in build
> self.builder.build_update()
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/builders/__init__.py",
>  line 299, in build_update
> len(to_build))
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/builders/__init__.py",
>  line 361, in build
> self.write(docnames, list(updated_docnames), method)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/builders/__init__.py",
>  line 535, in write
> self._write_serial(sorted(docnames))
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/builders/__init__.py",
>  line 545, in _write_serial
> self.write_doc(docname, doctree)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/builders/html.py",
>  line 616, in write_doc
> self.docwriter.write(doctree, destination)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/writers/__init__.py",
>  line 78, in write
> self.translate()
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/writers/html.py", 
> line 59, in translate
> self.document.walkabout(visitor)
> File "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/nodes.py", 
> line 178, in walkabout
> if child.walkabout(visitor):
> File "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/nodes.py", 
> line 178, in walkabout
> if child.walkabout(visitor):
> File "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/nodes.py", 
> line 178, in walkabout
> if child.walkabout(visitor):
> [Previous line repeated 9 more times]
> File "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/nodes.py", 
> line 170, in walkabout
> visitor.dispatch_visit(self)
> File "/home/murtaza/anaconda3/lib/python3.7/site-packages/docutils/nodes.py", 
> line 1912, in dispatch_visit
> return method(node)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinx/writers/html5.py",
>  line 861, in visit_math
> visit(self, node)
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/katex.py", 
> line 98, in html_visit_math
> self.body.append(run_katex(get_latex(node)))
> File 
> "/home/murtaza/anaconda3/lib/python3.7/site-packages/sphinxcontrib/katex.py", 
> line 88, in run_katex
> env=os.environ.copy()
> File "/home/murtaza/anaconda3/lib/python3.7/subprocess.py", line 775, in 
> __init__
> restore_signals, start_new_session)
> F

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

[Komiya Takeshi]

> 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 unneeded time to generate.
> So, is there a way i can know which target sphinx was launched with inside my 
> directive code, so i generate the video the good way ?

Directive itself should not know what builder is running now because
the output of the directive are cached and used to other builds
(a.k.a. incremental build feature). It would be better to process it
after the builder is determined. That is the resolving phase (see
https://www.sphinx-doc.org/en/master/extdev/index.html#build-phases).
So you need to process videos in two steps. 1) Generate an
intermediate node on the directive, and 2) process a video by type of
current builder on resolving phase.

```
from docutils import nodes

class my_video(nodes.Element):
"""A node for video"""
pass

class VideoDirective(Directive):
def run(self):
# generate a video node (please fill attributes using options
if you need it on latter step).
node = my_video()
return [node]

def on_doctree_resolved(app, doctree, docname):
# process my_video nodes only if HTML builds
# Note: you can also use "builder.format" to determine builder types.
if app.builder.name == 'html':
for video in doctree.traverse(my_video):
process_video(video)
```

Thanks,
Takeshi KOMIYA

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOs1XVQz5779r_UCfyD29pdJZK5XZt%3DsbfN%2Bc%3Dv8kUJXA%40mail.gmail.com.

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

[Komiya Takeshi]

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 many strings, for example, on the Nav Links sections, i have this 
> line: « * :ref:`genindex`  » that gets exported to pot files. Is there a way 
> i can set a string or a type of string (the strings that start with, a colon 
> for example) not to be exported in .pot ?
>
> Thanks in advance !
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/e8ac1ee9-7e34-4421-aee6-817f9f83a1bbn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPfmu4s-CJixM1QpeUxJhweeqbMat-cexwZo2aEP4mt1g%40mail.gmail.com.

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

[Komiya Takeshi]

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 have a project with two different index files (index.rst for html 
> and latex.rst for latex), because the HTML version has a section with 
> download links that should not be part of the latex versions. The point is 
> that at every build (both html and latex) there is a warning message 
> "latex.rst: WARNING: document isn't included in any toctree", although the 
> latex.rst is referenced:
> latex_documents = [
> ('latex', 'manual.tex', 'My Manual', '', 'manual', False),
>
> The warning itself does not create any problem in the build, except for a 
> file latex.html being created, it is just annoying. Adding :orphan: does not 
> help either
>
> My question is therefore: is there a (suggested) way to let this warning 
> disappear? Or, in other words, what is the correct way to set up the 
> source/index in these cases?
>
> Thanks for any pointer,
> Stefano
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/1b507b1e-f1d4-48da-82be-8809bc717155n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOvbZkySSoF4kvWvBS4BChKyOJ6mNVMhzxUt9jFdKdt8A%40mail.gmail.com.

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

[Komiya Takeshi]

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 version 1.8: Allowed to escape curly braces with backslash
>
> I therefore expect the input
>:samp:`\{ {x}, {y} \}'
> to have the first { in normal font, but in my tests it comes out in italic 
> font.
>
> How do I escape the { and } characters so that they display instead of 
> switching font in the :samp: role ?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/ba1df058-193d-489f-b89b-433ab8526f68n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMQZfRFSynZSrAGYCAAFNDg25MbVNuVsxxar0hnTSFfbg%40mail.gmail.com.

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

[Komiya Takeshi]

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 bradley...@gmail.com :
>
> I am using sphinx to build my github pages.
> When a file .rst changes, I get changes in the following files:
>
> .doctrees/environment.pickle
> .doctrees/.doctree
> _sources/.rst.txt
>  objects.inv
> .html
>
> I like to update my documentation corresponding to the master branch (the 
> bleeding edge) often. This includes changes to the release notes that say 
> what is different each time. I am worried that worried that this will cause 
> the size of my github repository to grow significantly. Has this been a 
> problem ? Is sphinx designed with this use case in mind ?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/03c1a340-f3f3-4ce0-a372-9b5100cea7e5n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAP14xSHN5G%2BV6jAwWR3A-UF68ghMt1RUA%3DV18HBOHHtGw%40mail.gmail.com.

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

[Komiya Takeshi]

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 - 
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option-py-class-final)
>
> Bottom of the page also says "Created using Sphinx 4.0.0+."
>
> How can I install Sphinx 4?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/40a91ef7-463e-4423-88c5-dd6b8186a413n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMr4kK1%2BWyWhXtpP-HcONAVBqnfLcsEk_bFwkpkyvL7GQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 -Dlanguage=xx value inside the
> conf.py, that would be appreciated (then I can write an if Japanese then
> 'platex' else 'xelatex' )
>
> Still looking for help for Arabic and Korean
>
>
> On Saturday, October 31, 2020 at 8:50:01 AM UTC+1 Pieter Claeys wrote:
>
>> Some more info on what is haunting me:
>> - Using sphinx 3.2.1 ;  latex_engine=xelatex  ; installed TeX Live
>> 2019/Debian Full
>> - Translations to html all build without problems
>> - generating pdf fusing 'sphinxbuild -b latex -Dlanguage=XX'  ; running
>> 'make' in the html dir
>> - PDF to Chines (zh_CW, zh_TW)  works (can't modify the topic title
>> anymore)
>> - However, to PDF:
>>
>>- *Korean *generates a PDF , but there seems to be a font missing
>>(many question mark characters)[image: Screenshot from 2020-10-31
>>08-43-28.png]
>>- *Japanese* doesn't generate a PDF
>>The error in the latex.log that comes first:
>>! LaTeX Error: This file needs format `pLaTeX2e'
>>   but this is `LaTeX2e'.
>>
>>And a lot of
>>Missing character: There is no リ in font
>>[FreeSansBoldOblique.otf]/OT:script=latn;language=dflt;!
>>Missing character: There is no ー in font
>>[FreeSansBoldOblique.otf]/OT:script=latn;language=dflt;!
>>Missing character: There is no ス in font
>>[FreeSansBoldOblique.otf]/OT:script=latn;language=dflt;!
>>- *Arabic* also fails latex building (no PDF generated ) at
>>Package polyglossia Warning: Patchingbiditablefailed! on input line
>>75.
>>! Package bidi Error: Oops! you have loaded package xcolor after bidi
>>package.
>>Please load package xcolor before bidi package, and then try to run
>>xelatex on
>>your document again.
>>See the bidi package documentation for explanation.
>>Type  H   for immediate help.
>>
>>
>>
>>
>> On Friday, October 30, 2020 at 6:00:17 PM UTC+1 Pieter Claeys wrote:
>>
>>> Hi,
>>> I'm failing miserably in building PDF's in Asian languages.
>>> Is there some more up-to-date information besides this thread:
>>> https://groups.google.com/g/sphinx-users/c/iaRNBHC_f5o/m/Acuwx26Nyq0J ?
>>> I have tried copy-pasting the latex preamble - unsuccessfully
>>>
>>> I'm using texlive on Ubuntu ;  using the xetex engine.
>>> (thanks to already previous help for Greek
>>> https://groups.google.com/g/sphinx-users/c/ShObSH4HqKI/m/WluKK74FBQAJ )
>>>
>>> I have installed debian packages textlive-lang-japanese, but that's
>>> appearantly not enough.
>>>
>> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/sphinx-users/9fe87947-83aa-4e33-bb58-2285d83cn%40googlegroups.com
> 
> .
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPYfrjWrw2MUYdAXbCdVasOy5dVmYXx-%2BTFD83oSDAmrg%40mail.gmail.com.

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

[Komiya Takeshi]

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 the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAN86QM%2BzuikqTiM8yqrwKvhM_zooWb8ZRoCkEmxvVYXNA%40mail.gmail.com.

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

[Komiya Takeshi]

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
> copy('../../README.md', '.')
>
> I want to delete this file after the documentation has been generated. How 
> can I instruct Sphinx to execute code after the generation?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/bb5f66de-4664-4673-a293-37e3eacd314cn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANcH92JOkusUAympaLFm3CZb7FwWNVoYCGtoENw8-%3Du8w%40mail.gmail.com.

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

[Komiya Takeshi]

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/` folder (represented as "Godot API" in the sidebar)

As a workaround, you can filter it using paths by own custom
search-engine. In this way, you don't need to make an indexer
extension.
Please check searchtools.js.

Thanks,
Takeshi KOMIYA

2020年10月24日(土) 2:32 Hugo Locurcio :
>
>
> Hi again,
>
> I'm one of the main contributors to Godot's documentation 
> (https://docs.godotengine.org). Right now, we have our "user manual" and 
> "class reference" pages under the same documentation site. This is convenient 
> for linking across pages, but the search quality suffers as both "user 
> manual" and "class reference" pages will appear in the search results without 
> any way for the user to distinguish them. In fact, it's one of the most 
> common complaints about our documentation system right now.
>
> One of the first solutions we've tried was to use Intersphinx to separate the 
> manual and class reference pages under different documentation sites. 
> Unfortunately, given our documentation pages are also translated in multiple 
> languages, we stumbled upon several limitations with it. This made it not a 
> very reliable solution for our needs: 
> https://github.com/godotengine/godot-docs/pull/3279
>
> At the very least, we'd like to add a way to distinguish between manual and 
> class reference pages in the search result (e.g. with a different icon next 
> to each result). Ideally, we'd prefer to add a button so the user can hide 
> manual or class reference results entirely from search. This can probably be 
> done with some custom JavaScript code, which I can handle.
>
> Can this be achieved using a Sphinx extension, or will I have to create a 
> custom search indexer from scratch to achieve this?
>
> PS: If this helps, all the class reference pages are under the same parent 
> `classes/` folder (represented as "Godot API" in the sidebar)
>
> Thanks in advance for replying,
> Hugo Locurcio
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/cdf141b0-3a54-4e21-af95-64ba8538c205n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMh8A85HFzBiOg9ZtrU00gZk6dMOdpxTFcqLCT_V%2Bv92A%40mail.gmail.com.

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

[Komiya Takeshi]

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 thinking about the deprecation of the package.

Before the deprecation action, I call for maintainers of
sphinx-testing package. If nobody raise a hand, I'll deprecate the
package soon.

Thanks,
Takeshi KOMIYA

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPR3NZNJMU1YpsR_Tfsm2QZLhzyArjzUz%3D_89G-bQw%3DnQ%40mail.gmail.com.

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

[Komiya Takeshi]

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. It removes spaces around
inline-markups. AFAIK, some Japanese users use it.
https://pypi.org/project/sphinxcontrib-trimblank/

Thanks,
Takeshi KOMIYA

2020年10月1日(木) 23:47 Pieter Claeys :
>
> I use a translation office to translate, using the .po workflow.
> For Japanese and Korean, there are no spaces between words (I just learned 
> this today - I don't know these languages).
> However, for a bold or italic (and other syntax), the sphinx rst parser 
> expects a space before and after a **part of phrase in bold**.  (some other 
> non-letter characters like . and : also close the syntax).
>
> So, when I build Japanse or Korean, I got large amounts of warnings related 
> to not closing the rst syntax.
> (WARNING: Inline strong start-string without end-string.)
>
> I can work around this by adding spaces. This solves the rst syntax problem, 
> but the spaces are also rendered in the final result - which is 
> understandable, but not perfect.
> (... and unfortunately Japanese people are striving for perfection :-))
>
> Any other ways to solve this ?  (I am using Sphinx 2.3.1, still - haven't 
> upgraded yet)
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/797d5fa3-6a56-4950-a280-8a644f1a1b9cn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOxbD-_sJ%2BhP5xB%2BiXk4guz-bOxe1YyBzQ5oFOsVKGsfA%40mail.gmail.com.

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

[Komiya Takeshi]

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,
>
> I have an .rst file with only one line
>
> .. automodule:: elephant.spike_train_processing
>
> `elephant/spike_train_processing.py` contains
>
> .. autosummary::
>  :toctree: toctree/spike_train_processing/
>  Synchrotool
>
> which produces
>
> .. autoclass:: Synchrotool
>
> but I want
>
> .. autoclass:: Synchrotool
>:members:
>
> How do I force :members: into each class throughout the whole python package?
>
> Thank you.
> Danylo
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/ba030079-4abb-4729-a3c7-d0f41c9d4c5cn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQANSZazbFCdN85tDch5hQtU0PPi11_vWsvKGviLNv0zsTA%40mail.gmail.com.

Re: [sphinx-users] make latexpdf

[Komiya Takeshi]

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 under the
_build/latex directory.
It invokes pdflatex multiple times automatically. I hope it helps you.

Thanks,
Takeshi KOMIYA

2020年9月13日(日) 6:32 bradley...@gmail.com :
>
>
> I am trying to figure out how to reproduce
> make latexpdf
> with separate calls to first build the latex and then run pdflatex. I want to 
> do this so I can directly modify the latex between the sphinx-build and 
> pdflatex (to accomplish things that are not supported by sphinx).
>
> I am using
> sphinx-build -b latex . _build/latex
> cd _build/latex
> pdflatex .tex
> where  is the value of project in my conf.py. When I do this I 
> get the error message
> No file .ind
> and the index is missing from my pdf.
>
> What am I missing here ?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/3540f597-7857-46b8-878f-1ede81adedean%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOO_xCb4LULBUYbgtuUfMHFtTh%2Bg2ewH%2BOrTU%3DC3Tb5%2BA%40mail.gmail.com.

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

[Komiya Takeshi]

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():
print(c_object)


def setup(app):
app.connect('env-check-consistency', on_env_check_consistency)
```

Note: This hooks "env-check-consistency" event and get C objects from C domain.
For more details, please read developers reference:
* https://www.sphinx-doc.org/en/master/extdev/index.html
* https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events
* 
https://www.sphinx-doc.org/en/master/extdev/domainapi.html#sphinx.domains.Domain.get_objects

Thanks,
Takeshi KOMIYA

2020年9月12日(土) 0:16 Matias v01d :
>
> Hi,
> we're using Sphinx to document a C interface. I would like to get a list of 
> all documented functions, structs, types, etc, generated and output
> to a file in YAML/JSON or similar in order to use this to automatically check 
> API stability by comparing to previous releases.
> Is this possible somehow?
>
> Thanks,
> Matias
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/62f3be60-dc02-4325-a33c-0ec973f0c104o%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOf%3D%3DWtDfZRd7OC%3DUgNeXw_%3DZ%3DbjETW-9k%2BNXO8yFpVrg%40mail.gmail.com.

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

[Komiya Takeshi]

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. Kugler :
>
> In my document, I have various bits of code like this:
>
> ```
> # code
> ```
>
> They are lexed and pygmentize'd correctly. However, I have a block like this:
>
> ```powershell
> # powershell code
> ```
>
> pygmentize -L lists "powershell" as a type of code it can lex and highlight.
> However, I get this warning from sphinx:
>
> /home/jkugler/repos/frb/devkit-python/docs/installing-devkit.md: WARNING:
> Could not lex literal_block as "powershell". Highlighting skipped.
>
> I uninstalled python3-pygments as a test, and sphinx would not run without it,
> so I know that's the one it's using.
>
> Ideas?
>
> j
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/6311453.lOV4Wx5bFT%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPVyHhuaLAhgLgEiRAAngv9x%3DomF3_rjU_ehVR3j-wE6A%40mail.gmail.com.

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

[Komiya Takeshi]

Now the patterns are considered as relative paths from the current
directory and converted to absolute paths before matching.

2020年9月12日(土) 7:17 Joshua J. Kugler :
>
> I could try that, but the directory isn't at ../test_files. sphinx uses
> fnmatch, so should match *any*path that 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?
> >
> > 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 [OPTIONS] -o   [EXCLUDE_PATTERN …]
> > >
> > > Any EXCLUDE_PATTERNs given are fnmatch-style file and/or directory
> > > patterns
> > > that will be excluded from generation.
> > > """
> > >
> > > My tree looks like this:
> > >
> > > devkit/tests/test_files/
> > >
> > > My command for apidoc looks like this:
> > >
> > > sphinx-apidoc -f -e -M  --implicit-namespaces -o ./modules ../devkit/
> > > 'test_files/*'
> > >
> > > That doesn't exclude things in test_files/. I tried '*/test_files/*' as
> > > well as *test_files* as well as 'devkit/tests/test_files/*' but an rst
> > > file is still be creating for python files in the test_files tree.
> > >
> > > What am I doing wrong?
> > >
> > > Thanks!
> > >
> > > j
> > >
> > > --
> > > Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> > > Azariah Enterprises - Programming and Website Design
> > > PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
> > >
> > >
> > > --
> > > You received this message because you are subscribed to the Google Groups
> > > "sphinx-users" group. To unsubscribe from this group and stop receiving
> > > emails from it, send an email to
> > > sphinx-users+unsubscr...@googlegroups.com. To view this discussion on the
> > > web visit
> > > https://groups.google.com/d/msgid/sphinx-users/3490677.efuseTzYfb%40hosan
> > > na.
>
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/3566575.aeNJFYEL58%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO1uTC9FwuOYtAbAd0ucKRxH0cQNtp1ca-AX769pEqJpw%40mail.gmail.com.

Re: [sphinx-users] Selective inclusion of Javascript

[Komiya Takeshi]

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 UTC+2 i.tk...@gmail.com wrote:
>>
>> 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 
>> > inserts the JS in *every* html page. I was wondering if there is a proper 
>> > way to do so or if someone has come up with a possible solution.
>> >
>> > I think this could be useful in many scenarios. Think for example of a web 
>> > site with lots of mathjax code in only one page: by using add_js_file, the 
>> > js would be included in all pages, although not necessary.
>> >
>> > More generally, if you use an extension that adds its own JS, that JS will 
>> > be added to all pages, although it is necessary only in pages on which you 
>> > use the extension's functionality.
>> >
>> > Thanks for any thoughts!
>> > Stefano
>> >
>> > --
>> > You received this message because you are subscribed to the Google Groups 
>> > "sphinx-users" group.
>> > To unsubscribe from this group and stop receiving emails from it, send an 
>> > email to sphinx-users...@googlegroups.com.
>> > To view this discussion on the web visit 
>> > https://groups.google.com/d/msgid/sphinx-users/5d7540f6-f206-4949-964c-04a72d9fc5f7n%40googlegroups.com.
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/4fef83ab-715c-49fa-a0eb-af7709321fdan%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOdXc%3DLrsT%2Bdpog1G2bHX7xJR6Qj8f%2BMsaaNhu2Yuq6Wg%40mail.gmail.com.

Re: [sphinx-users] Selective inclusion of Javascript

[Komiya Takeshi]

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 
> inserts the JS in *every* html page. I was wondering if there is a proper way 
> to do so or if someone has come up with a possible solution.
>
> I think this could be useful in many scenarios. Think for example of a web 
> site with lots of mathjax code in only one page: by using add_js_file, the js 
> would be included in all pages, although not necessary.
>
> More generally, if you use an extension that adds its own JS, that JS will be 
> added to all pages, although it is necessary only in pages on which you use 
> the extension's functionality.
>
> Thanks for any thoughts!
> Stefano
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/5d7540f6-f206-4949-964c-04a72d9fc5f7n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPAgZT%2BCqVtBtPS71Viebo8%2BTmjbsJK%3D1aHaCbrrNa38A%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> the sense that it reads in the table and puts it in the html, but it doesn't 
> seem to be paying attention to what I put after :widths:
>
> That is, I get the same thing, whether I omit :widths: or put in something 
> like
>
>   :widths: 45, 10, 45
>
> (I have a CSV with two wide columns and a small one in the middle).
>
> I am using sphinx 4.0.0+ on linux.
>
> I'd appreciate any advice!
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/79b05027-1eb9-4a29-8ef5-6366a2ff4f59n%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMw%3Dn-KNWtkhKzKUZiQAPmKo8L9JN4Vu2KUuY7OoPLZ-Q%40mail.gmail.com.

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

[Komiya Takeshi]

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 [OPTIONS] -o   [EXCLUDE_PATTERN …]
>
> Any EXCLUDE_PATTERNs given are fnmatch-style file and/or directory patterns
> that will be excluded from generation.
> """
>
> My tree looks like this:
>
> devkit/tests/test_files/
>
> My command for apidoc looks like this:
>
> sphinx-apidoc -f -e -M  --implicit-namespaces -o ./modules ../devkit/
> 'test_files/*'
>
> That doesn't exclude things in test_files/. I tried '*/test_files/*' as well 
> as
> *test_files* as well as 'devkit/tests/test_files/*' but an rst file is still 
> be
> creating for python files in the test_files tree.
>
> What am I doing wrong?
>
> Thanks!
>
> j
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/3490677.efuseTzYfb%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMvXr%2B%3D3w%2BK3gj5eZTfRXQY1d2dp3VY6ozP6MguFKDfXg%40mail.gmail.com.

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

[Komiya Takeshi]

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 
> [issue](https://github.com/sphinx-doc/sphinx/issues/8062) and tk0miya invited 
> me to ask sphinx-users too.
>
> It is a personal feeling, but I am not comfortable with asking questions on 
> this google-group for various reasons. I think it could be a good choice to 
> invite sphinx-users to ask their questions directly on StackOverflow. People 
> can then watch the `python-sphinx` tag and easily answer the questions, or 
> search for an existing one.
>
> What do you guys think?
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/0dc50072-61ff-4a5a-94a4-4608ab713e1fn%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPzv_Fg5m%3DLw6jGDRAb8sqXz9XEnX11bcjzMAQ_XN%3D0hA%40mail.gmail.com.

Re: [sphinx-users] Disambiguating intersphinx references

[Komiya Takeshi]

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
references will be linked to the local project by default. It will be
linked to external documents only if the label is not found on the
local document.

Thanks,
Takeshi KOMIYA

2020年8月14日(金) 23:58 R Edgar :
>
> Greetings,
>
> I'm trying to generate a reference to my project's examples, as generated by 
> sphinx-gallery. The normal way to do this is:
> :ref:`sphx_glr_auto_examples`
> (since the target is defined by Sphinx gallery itself). However, we are also 
> using intersphinx to reference our dependencies, and SciKit-Learn also uses 
> sphinx-gallery. When our documentation is built, the link generated points at 
> the SciKit-Learn examples, rather than our own.
>
> How do I force the link to reference the target in our project, rather than 
> the one in SciKit-Learn? I've been trying adding things like :project: and 
> :Fairlearn: (the name of our project in conf.py) at various places, but they 
> are not working.
>
> Thanks in advance,
>
> Richard
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/278871ec-bbca-47ec-ae28-94803ea89dddo%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAP9%3Dkzq4br09k4Gk1RvOJFAKMRnYe%3Dm8-yAbZwjtOiyKA%40mail.gmail.com.

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

[Komiya Takeshi]

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 you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM2iyAX%2BhEe%3Drdh-k0wgyztXaHVk7u8G8eHdd61t02zkQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 :
>
> According to PyPi the latest version of Sphinx is 3.2.0, but https://
> www.sphinx-doc.org/en/master/contents.html (And all docs) say the docs are for
> 4.0.0+. How does one acquire 4.0.0? Why were the docs released before the
> code? :)
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/1932046.MPdnpNZkfA%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAMgbQ0o0iqXQ8EbFLfaW1SWp3KjKUuqSN_TJK9NqHiCow%40mail.gmail.com.

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

[Komiya Takeshi]

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 have a Python project for which I've generated
> > docs. It did well. Almost everything was doc'ed. I know about the default
> > of excluding anything starting with '_' so I created an autodoc-skip-member
> > function that would include those. It works. I see a bunch of private
> > methods and functions included. But...I have a module, let's call it XYZ
> > that has both private and public functions. Sphinx is only doc'ing the
> > public functions of XYZ, but not its private functions. I have other
> > modules that have private functions, and it's doc'ing those.
> >
> > I added a print() to the autodoc-skip-member function and it doesn't even
> > print out the `name` of those private functions so it seems it's not even
> > seeing it.
>
> So, I figured this out. The file concerned had an __all__ statement. So, on 
> one
> hand, I understand the reason it was being excluded, but on the other hand,
> why does __all__ prevent passing the identifiers the autodoc-skip-member
> function?
>
> That said, this is probably doc'ed somewhere, eh?  Anybody got a pointer? :)
>
> j
>
> --
> Joshua J. Kugler - Fairbanks, Alaska - jos...@azariah.com
> Azariah Enterprises - Programming and Website Design
> PGP Key: http://pgp.mit.edu/  ID 0x68108cbb73b13b6a
>
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/25359779.uLBTZSqOf5%40hosanna.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAO8g046c5fikZLYPcRWZqDUv1q%3DP6J7Z5gVzDfRntwb%2BQ%40mail.gmail.com.

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

[Komiya Takeshi]

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 or post-transforms are applied (i.e. directly after the parser 
> phase)?
>
> I am writing an extension to convert reST to Myst syntax but I am finding 
> restoring some of the information contained in the original rst file 
> difficult to recover. The key example is a `toctree` that uses the `:hidden:` 
> option appears to be dropped from the AST here 
> (https://github.com/sphinx-doc/sphinx/blob/e4a55cb76f7f45e74997017b8fa4ca913d0ac602/sphinx/environment/adapters/toctree.py#L65)
>
> Any tips / hints would be great -- thanks for your time.
>
> Cheers,
> Matt
>
> --
> You received this message because you are subscribed to the Google Groups 
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to sphinx-users+unsubscr...@googlegroups.com.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/sphinx-users/1e767f7a-6a03-4a0d-a22d-4326716299c3o%40googlegroups.com.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAP%3Du8_GVN%2BaiCUbXm%3D6_ZQGWk8BsubfiSd%3DR2ua7mGqhw%40mail.gmail.com.