Re: [sphinx-users] Omit version "v" from Intersphinx link hovertext?

2017-10-30 Thread Komiya Takeshi
nday, October 29, 2017 at 10:11:22 AM UTC-4, Komiya Takeshi wrote: >> >> Hi, >> >> Sphinx expects version is always present. So it is always rendered as >> "v(version)". >> Indeed, version is not required for some kind of documents. >> +1 for make v

Re: [sphinx-users] Omit version "v" from Intersphinx link hovertext?

2017-10-29 Thread Komiya Takeshi
Hi, Sphinx expects version is always present. So it is always rendered as "v(version)". Indeed, version is not required for some kind of documents. +1 for make version as optional. Thanks, Takeshi KOMIYA 2017-10-27 6:22 GMT+09:00 'Erin Kelly' via sphinx-users < sphinx-users@googlegroups.com>: >

Re: [sphinx-users] Sphinx "htmlhelp" target problem

2017-10-20 Thread Komiya Takeshi
Hi, Could you share a reproducible example for us? I'll take a look. (But I don't have Windows PC, so I will not be able to reproduce it locally...) Takeshi KOMIYA 2017-10-20 2:50 GMT+09:00 vibebusiness3 : > Hello, > > I am using Sphinx "make htmlhelp" to build WindowsHTML files, which I > th

Re: [sphinx-users] Tweaking automatic section numbering?

2017-10-16 Thread Komiya Takeshi
Hi Matthew, Thank you for filing an issue. And sorry for late response. Unfortunately, the sphinx-core team (including me) don't have enough time to resolve all of issues and proposals. Now we're working on watching issues day by day, so please wait a moment. BTW, it seems your request needs to m

Re: [sphinx-users] How to use substitution in code-block with code highlight

2017-10-04 Thread Komiya Takeshi
Hi Kengo, AFAIK, there are no way to do that. You need to search 3rd party extension or make new one to do that. parsed-literal is very powerful. It can generate literal-block including decorated text (em, strong and so on), hyperlinks, images, and so on. so it is hard to highlight its result. Of

Re: [sphinx-users] dynamic domain in a rst file?

2017-09-25 Thread Komiya Takeshi
st be a variable like in php: > > $_SERVER['SERVER_NAME'] > > > > On Monday, September 25, 2017 at 9:53:13 AM UTC+2, Komiya Takeshi wrote: >> >> Hi, >> >> How about copying the generated HTML files to /doc directory or root >> directory

Re: [sphinx-users] dynamic domain in a rst file?

2017-09-25 Thread Komiya Takeshi
Hi, How about copying the generated HTML files to /doc directory or root directory? Thanks, Takeshi KOMIYA 2017-09-25 4:56 GMT+09:00 B. Rentrug : > hi... > > i made a help for my online software and i have a link to it in the top bar. > > now im using different domain (.de and .ch) and i need a

Re: [sphinx-users] Modifying make.bat for Python 3 when there are 2 different interpreters in an environment

2017-09-04 Thread Komiya Takeshi
Hi, Sphinx still support 2.7, so `-3` option is not acceptable as a default settings of make.bat. I'm a beginner of Windows. so I don't know best solution for the platform. So I will accept better implementation if everyone votes it. Thanks, Takeshi KOMIYA 2017-09-04 7:00 GMT+09:00 Colathur Vij

Re: [sphinx-users] Suppress info messages from import

2017-09-04 Thread Komiya Takeshi
Hi, 1. Sphinx does not filter envvars. It might be related with GNU make. How about invoke sphinx-build command directly? 2. If you've used autodoc, autodoc_mock_imports will help you. Thanks, Takeshi KOMIYA 2017-09-04 13:20 GMT+09:00 Bruce Sharpe : > One of my modules imports TensorFlow. This

[sphinx-users] Request for testing: new parser for autodoc

2017-07-16 Thread Komiya Takeshi
Hi all, Now I'm going to replace python parser module (pycode) for autodoc by new one. https://github.com/sphinx-doc/sphinx/pull/3937 It allows to parse correctly new syntax of python 3 (ex. async, type annotations and so on). On my local, it works fine. But, before merging, I'd like to test it m

Re: [sphinx-users] Re: Embedding videos in sphinx

2017-07-15 Thread Komiya Takeshi
Hi, The files under _static/ directory are copied into build/html/_static/ directory. So you need to use relative paths inside raw directive like following:: .. raw:: html 2017-07-13 16:38 GMT+09:00 PRIYANKA KAUL : > The project structure is like this: > > Project_Name > _static >

Re: [sphinx-users] Texinfo equivalent commands

2017-07-02 Thread Komiya Takeshi
Hi, >From what I've seen, there are no such command in Sphinx and its texinfo builder. Basically Sphinx does not have commands for page layouting. As a workaround, you might be able to use following notation instead. .. raw:: texinfo @need 800 Thanks, Takeshi KOMIYA 2017-06-27 16:48

Re: [sphinx-users] sphinx_rtd_theme and topic directive

2017-07-02 Thread Komiya Takeshi
You're right, juh. nobody promises topic always has frame. So this is not a bug. It's a "flavor" of the theme! 2017-06-27 14:59 GMT+09:00 Jan Ulrich Hasecke : > > > Am 26.06.2017 um 13:24 schrieb Joanna: >> I use sphinx_rtd_theme. >> >> I try to use topic directive. >> >> .. topic:: This is topic

Re: [sphinx-users] sphinx_rtd_theme and topic directive

2017-06-26 Thread Komiya Takeshi
Hi, I think it's bug of sphinx_rtd_theme. Please report rtd team. Thanks, Takeshi KOMIYA 2017-06-26 20:24 GMT+09:00 Joanna : > I use sphinx_rtd_theme. > > I try to use topic directive. > > .. topic:: This is topic > > Subsequent indented lines comprise > the body of the topic, and are > interpre

Re: [sphinx-users] Bokeh Gallery extension problem with 1.6+ (seeking better practices)

2017-06-25 Thread Komiya Takeshi
Hi Bryan, Sphinx sets `env.docname` during reading docs (env.read_doc()). So I feel a bit strange your situation. Could you share stacktrace of the error? Thanks, Takeshi KOMIYA 2017-06-24 6:27 GMT+09:00 Bryan Van de ven : > Hi All, > > I've developed a "bokeh-gallery" extension to help with aut

Re: [sphinx-users] Disable changing language (locale) for Sphinx build system

2017-05-30 Thread Komiya Takeshi
Hi Jeroen, Thank you for reporting. Could you file this as an issue on github? I will take a look later. Thanks, Takeshi KOMIYA 2017-05-19 19:19 GMT+09:00 Jeroen Demeyer : > Hello, > > I'm trying to upgrade from Sphinx-1.5.3 to Sphinx-1.6.1 in SageMath. > > The SageMath documentation is multi-li

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

2017-05-30 Thread Komiya Takeshi
Hi, Sorry, I can't read German. But I guess it says the value of `` is invalid. It seems you are not specifying `epub_identifier`. The content.opf says it is "unknown" (the default value of epub_identifier). Usually ISBN or URLs are used to the value. Please check it. Thanks, Takeshi KOMIYA 201

[sphinx-users] Sphinx-1.6.2 has been released

2017-05-28 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.6.2, now available on the Python package index at . It includes about 23 bug fixes for the 1.6.1 release series. For the full changelog, go to . Thanks

Re: [sphinx-users] Author information

2017-05-27 Thread Komiya Takeshi
Hello Mario, reStructuresText notation supports to mark up metadatas as bibliographic fields. So you can write author information to each .rst files. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bibliographic-fields But sphinx does not refers it AFAIK. Thanks, Takeshi KOMIY

Re: [sphinx-users] Extension broken in 1.6.1

2017-05-27 Thread Komiya Takeshi
Hi Peter, >From v1.6, we started to enable smart_quotes option of docutils. It seems your case might be a side effect of that. As a quick look, docutils replaces nodes of Text subclasses to Text node. Usually Text nodes are only used to represent texts (strings). So I feel a bit strange to derive

Re: [sphinx-users] Sphinx-1.6 final has been released

2017-05-17 Thread Komiya Takeshi
; Am 16.05.2017 um 17:56 schrieb Komiya Takeshi: >> Hi all, >> >> I'm delighted to announce the release of Sphinx 1.6 final, now available on >> the Python package index at <http://pypi.python.org/pypi/Sphinx>. >> >> It includes about 33 new feature

[sphinx-users] Sphinx-1.6 final has been released

2017-05-16 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.6 final, now available on the Python package index at . It includes about 33 new features, 29 bug fixes and 23 incompatible changes for the 1.5.6 release. For the full changelog, go to

Re: [sphinx-users] how to use a specific latex class

2017-05-15 Thread Komiya Takeshi
Hi, Unfortunately, there are no guideline to do that AFAIK. As you tried, certainly you can do it through latex_docclass. But nobody knows proper way to make customized style file... It would be very nice if you find the way and contribute it to official docs :-) Thanks, 2017-05-15 21:04 GMT+09

Re: [sphinx-users] :numref: numbering of Figures in PDF (XeLatex) - error: WARNING: no number is assigned

2017-05-11 Thread Komiya Takeshi
> > On Thursday, May 11, 2017 at 1:45:30 AM UTC-5, Komiya Takeshi wrote: >> >> Hi Barbara, >> >> I'd tried to reproduce your problem, but I could not. on my local, it >> is able to refer the figures. >> Could you share your project or provide minimal

Re: [sphinx-users] Adding hyperlink to guilabel

2017-05-10 Thread Komiya Takeshi
Hi Marvin, AFAIK, there are no proper way to link inline element. How about make hyperlink target before the paragraph having the guilabel? Thanks, Takeshi KOMIYA 2017-05-11 0:05 GMT+09:00 Marvin Herbold : > I tried Googling for the answer (rst sphinx guilabel hyperlink) and couldn't > really fi

Re: [sphinx-users] :numref: numbering of Figures in PDF (XeLatex) - error: WARNING: no number is assigned

2017-05-10 Thread Komiya Takeshi
Hi Barbara, I'd tried to reproduce your problem, but I could not. on my local, it is able to refer the figures. Could you share your project or provide minimal reproducible one? If possible, it would be nice if you file this into our issues list. https://github.com/sphinx-doc/sphinx/issues Thanks

Re: [sphinx-users] Which files are involved in search results?

2017-05-10 Thread Komiya Takeshi
.rst.txt but > there's a better workaround in that github link. > > > On Wednesday, May 3, 2017 at 4:24:45 AM UTC-4, Komiya Takeshi wrote: >> >> Hi, >> >> Please copy searchindex.js and files under the html/_sources/. >> Our search script uses sear

[sphinx-users] Sphinx-1.6b3 has been released

2017-05-07 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.6 beta3, now available on the Python package index at . It includes about 3 new feature and 8 bug fixes for the 1.6b2 release. For the full changelog, go to

Re: [sphinx-users] Which files are involved in search results?

2017-05-03 Thread Komiya Takeshi
Hi, Please copy searchindex.js and files under the html/_sources/. Our search script uses searchindex.js for searching at first, and also uses sources files to display the search result. Thanks, Takeshi KOMIYA 2017-05-02 6:00 GMT+09:00 'Erin Kelly' via sphinx-users : > I'm trying to figure out

[sphinx-users] Re: How to add ruby code inside sphinx conf

2017-05-02 Thread Komiya Takeshi
Hi Loganathan, This is a list for sphinx documentation generator, not sphinx search engine too. So nobody can't answer your question. Thanks, 2017年5月3日水曜日 8時13分14秒 UTC+9 Loganathan Sellappa: > > Hello, > > I'm using Sphinx search engine for my application, and I would like to add > ruby code i

[sphinx-users] Sphinx-1.6b2 has been released

2017-04-29 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.6 beta2, now available on the Python package index at . It includes about 29 new feature and 14 bug fixes for the 1.5.x release series. For the full changelog, go to

[sphinx-users] Call for translation updates

2017-04-29 Thread Komiya Takeshi
Hi all, for the pending 1.6 release I'd like to add/update as many locales as possible. You can translate Sphinx system messages 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. We

Re: [sphinx-users] Parsing inline literals

2017-04-16 Thread Komiya Takeshi
Hi, Unfortunately, nested inline markup is not allowed in reST spec. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup Thanks, Takeshi KOMIYA 2017-04-14 23:32 GMT+09:00 Mark Peters : > Hi, > > Is it possible to parse an inline literal to replace text using > substi

Re: [sphinx-users] Extended ASCII chars in reST files not recognized.

2017-04-14 Thread Komiya Takeshi
Hi, In my local, it seems Sphinx can build the document without errors. I used Sphinx-1.5.5. Could you paste your full document and full error messages? I've never seen the messages you pasted in both sphinx and docutils. Thanks, Takeshi KOMIYA 2017-04-14 1:41 GMT+09:00 Jim Klo : > Greetings, >

Re: [sphinx-users] tool for translating RST files

2017-04-12 Thread Komiya Takeshi
Hi, In Sphinx project, we use sphinx-intl and transifex. I feel these combination is very nice. Thanks, 2017-04-12 22:41 GMT+09:00 ticapix : > Hi, > > In the company I'm working in, we have hundreds of RST files > (ReStructuredText) and we are looking for a tool to help us translate those > file

Re: [sphinx-users] Question about replace directive

2017-04-05 Thread Komiya Takeshi
Hi, How about this? .. |newpage| raw:: latex \newpage Thanks, 2017-04-06 0:22 GMT+09:00 vibebusiness3 : > Hello, I am trying to make a shortcut command to make pagebreaks in latex > output. I am doing this: > > .. |newpage| replace:: > >.. raw:: latex > > \newpage > > but when I p

Re: [sphinx-users] How to handle 'display name' for add_object_type?

2017-04-05 Thread Komiya Takeshi
Hi, Sphinx.add_object_type() uses `sphinx.domains.std.GenericObject` for an implementation of the directives. It does not make entries unique. As a quick look, you should use your own directive class. Thanks, 2017-04-06 2:03 GMT+09:00 : > I am using Sphinx's add_object_type to create a custom o

Re: [sphinx-users] Generating latex in index

2017-03-25 Thread Komiya Takeshi
Hi, AFAIK, there are no way to do that. The index directive does not support inline mark up. Thanks, Takeshi KOMIYA 2017-03-25 1:10 GMT+09:00 vibebusiness3 : > I am trying to include math in an index entry with: > > .. index:: :math:`f_n(x)` > > however sphinx puts the full ":math:`f_n(x)`" as a

Re: [sphinx-users] Why does this warn? ":ref:" inside ".. only::"

2017-03-18 Thread Komiya Takeshi
Hi, Unfortunately, the "only" blocks are processed regardless of builders once. And be suppressed them in later process. So please use "suppress_warnings" configration to suppress it. Thanks, 2017-03-15 2:18 GMT+09:00 Pete : > I only want to include the text with :ref:`installation` when buildin

Re: [sphinx-users] Strange behavior with include directive

2017-03-18 Thread Komiya Takeshi
Hi, The warnings come from that sphinx processed foo.rst twice. So please rename it to non .rst file or add it to exclude_patterns. Thanks, Takeshi KOMIYA 2017-03-18 7:46 GMT+09:00 vibebusiness3 : > Hello, > > I have a file called "chapter.rst" which is included in my index.rst > toctree. Here

Re: [sphinx-users] Disable a certain section of the docs based on the local environment?

2017-03-11 Thread Komiya Takeshi
Hi, How about adding the file to exclude_patterns if the library not installed? Thanks, Takeshi KOMIYA 2017-03-11 2:11 GMT+09:00 Matthias Geier : > Dear list. > > Following scenario: > > * A small part of the docs uses a certain Sphinx extension with some > dependencies to parse source files. >

Re: [sphinx-users] How to make new directives

2017-03-11 Thread Komiya Takeshi
Hi, Did you see the tutorial? I hope it will help your development. http://www.sphinx-doc.org/en/stable/extdev/tutorial.html Thanks, Takeshi KOMIYA 2017-03-11 1:42 GMT+09:00 vibebusiness3 : > I'm looking for an efficient way to display math equations correctly in both > html/pdf and texinfo outp

Re: [sphinx-users] sphinx-build Segmentation fault (core dumped)

2017-03-11 Thread Komiya Takeshi
Hi, You can use -vvv or -P option for debugging. If you feel this is bug of Sphinx-core, please report to github issues. Thanks, 2017-03-11 6:05 GMT+09:00 Anh Nguyen : > Anybody run into this or know how to debug the source of the core dump? I'm > using sphinx 1.5.3 and python 2.7. > > $ sphinx-

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

2017-03-06 Thread Komiya Takeshi
this bug fix, we simply escape it for LaTeX builder. So you don't need to escape the variable. Thanks, Takeshi KOMIYA 2017-03-06 21:14 GMT+09:00 Roberto Bagnara : > On 02/26/2017 04:57 PM, Komiya Takeshi wrote: >> I'm delighted to announce the release of Sphinx 1.5.3, now availab

Re: [sphinx-users] Re: Relative paths - File not readable

2017-03-06 Thread Komiya Takeshi
Hi, Sphinx expects the project directory contains all documents and related files. So there are no proper way to access the images outside of the project. Please move it to under project directory. Thanks, Takeshi KOMIYA 2017-03-07 3:37 GMT+09:00 sajan mushini : > hey > > A newbie here and I h

Re: [sphinx-users] How to put references at end of each chapter with Sphinx

2017-03-03 Thread Komiya Takeshi
Hi, AFAIK there are no way to do that. You might customize LaTeX builder as an extension. As a quick look, refsection environment makes "per chapter" bibliography in LaTeX. So it might be easily to make the extension. http://tex.stackexchange.com/questions/87414/per-chapter-bibliographies-in-bibl

Re: [sphinx-users] How to document my_package/__init__.py

2017-03-03 Thread Komiya Takeshi
Hi, 1) :members: option will help you 2) There are no way to do that Thanks, Takeshi KOMIYA 2017-03-01 22:56 GMT+09:00 andre seame : > Hello, > > > This is my code. > > > my_package (that contains __init__.py and fct1.py) > > __init__.py > > """ > .. automodule:: consoleMod.fct1 >:members: >

Re: [sphinx-users] existing project documentation won't build with 1.5.1 or 1.5.3: the linkcheck problem

2017-03-01 Thread Komiya Takeshi
Hi Pete, Yes, please. We, sphinx-dev recognizes the problems are resolved. So please report it if you still got error. I'd like to know your stacktrace, environment info (OS, packages and pip list) Thanks, Takeshi KOMIYA 2017-03-02 8:33 GMT+09:00 Pete : > This is a problem with 1.5.1 & 1.5.3, bu

[sphinx-users] Sphinx-1.5.3 has been released

2017-02-26 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.5.3, now available on the Python package index at . It includes about 3 new feature and 16 bug fixes for the 1.5.2 release series. For the full changelog, go to

Re: [sphinx-users] custom css class to toctree

2017-02-24 Thread Komiya Takeshi
Hi, You're right. All directives should have :class: option. But toctree does not have it. Could you file that as a issue of Sphinx? I'll work it later. Thank you for reporting Takeshi KOMIYA 2017-02-24 8:57 GMT+09:00 Aladdin Mhaimeed : > Hi, > I use sphinx with sphinx_rtd_theme, and this is my

Re: [sphinx-users] Getting extension directive data into JSONHTMLBuilder output

2017-02-24 Thread Komiya Takeshi
Hi, It seems JSON builder generates HTML using HTML builder and put it into JSON file. So you might put the status through html visitor method. Thanks, Takeshi KOMIYA 2017-02-25 5:00 GMT+09:00 Paul Everitt : > Hi, hopefully this is an easy question. Let's say I'm making a todolist > extension, e

Re: [sphinx-users] reducing duplication with multiple builders?

2017-02-24 Thread Komiya Takeshi
#x27;t set up > the CI component here yet) this overhead will cost tens of seconds of time > per CI run. It's not a huge problem for us--just making sure I wasn't > overlooking some simple way to trim the wasted time. > > On Thursday, February 23, 2017 at 9:38:43 AM UTC-6,

Re: [sphinx-users] Re: Sidebar alphabetical?

2017-02-23 Thread Komiya Takeshi
Hi, There are no way to sort the entries on sidebar in Sphinx itself. As Kelly said, Sphinx lists them in order of toctree. Of course, you can do that with your own extension. Thanks, Takeshi KOMIYA 2017-02-23 7:27 GMT+09:00 'E. Kelly' via sphinx-users : > I think Sphinx uses the order in the t

Re: [sphinx-users] reducing duplication with multiple builders?

2017-02-23 Thread Komiya Takeshi
Hi Travis, >1. For performance reasons it'd be nice to reduce duplication across all of >these builds, but it doesn't look like Sphinx supports multiple builders in a >single run. What did you mean "duplication"? Surely Sphinx does not support to invoke multiple builders in a single run. But Sp

Re: [sphinx-users] Re: How to use multiple paths for python modules documentation in different directories using sphinx autodoc?

2017-02-18 Thread Komiya Takeshi
It seems your case is simply python's problem, not sphinx's. How about this? sys.path.insert(0, os.path.abspath("..")) Thanks, Takeshi KOMIYA 2017-02-18 9:33 GMT+09:00 nshea : > The way my modules are structured, there is an __init__.py in both the > python_modules_A and the python_modules_B dir

[sphinx-users] Re: Best way to cross-reference in RST to a generated index page?

2017-02-14 Thread Komiya Takeshi
Hi, You can refer the general index and python-module index using :ref: role (:ref:`genindex` and :ref:`modindex`). But we can not refer other index pages using the role. AFAIK there are no way to make links to them. BTW the index pages are not a "document". so you can use :doc: role to refer t

[sphinx-users] Re: Align html_logo?

2017-02-14 Thread Komiya Takeshi
Hi, You can do it with custom stylesheet: https://groups.google.com/d/msg/sphinx-users/x57bVbsmwTM/O0ICZ-ANDwAJ Thanks, Takeshi KOMIYA 2017年2月9日木曜日 11時43分01秒 UTC+9 imans314: > > Is there a way to set the html_logo to the centre of the sidebar? > > > -- You received this message because you are

Re: [sphinx-users] Change color of table header

2017-02-03 Thread Komiya Takeshi
Hi, You can change it by custom css: http://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file 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 ema

Re: [sphinx-users] How to modify text on the HTML search page?

2017-02-01 Thread Komiya Takeshi
The page is generated by templating feature. So please add user template named "search.html". refs: http://www.sphinx-doc.org/en/stable/templating.html Thanks, Takeshi KOMIYA 2017-02-02 1:19 GMT+09:00 'E. Kelly' via sphinx-users < sphinx-users@googlegroups.com>: > I want to change the default t

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

2017-01-31 Thread Komiya Takeshi
with theses file is : > >>sphinx-build src/main/sphinx/test build/site/test -blatex >>cd build\site\test >>pdflatex softbridge > > With the workaround (line 29 in conf.py) I have the TOC, If workaround is > commented I don't have it. > > Franck > >

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

2017-01-31 Thread Komiya Takeshi
3.4 has decided to set this to "-2" in one of the newer >> versions. >> % Set it "1", which is what we are looking for >> \setcounter{tocdepth}{1} >> \tableofcontents >> """ >> >> latex_elements = { >> ... >>

[sphinx-users] Sphinx-1.5.2 has been released

2017-01-22 Thread Komiya Takeshi
Hi all, I'm delighted to announce the release of Sphinx 1.5.2, now available on the Python package index at . It includes about 5 new feature and 28 bug fixes for the 1.5.1 release series. For the full changelog, go to

[sphinx-users] Re: Sphinx Search yellow highlight creates extra white space

2017-01-13 Thread Komiya Takeshi
Hi, I believe it is caused by stylesheets. What theme do you use? Alabaster (sphinx's default)? rtd_theme? Anyway, sphinx uses .highlighted class to the highlighted words. So please replace or update your stylesheet to erase paddings or margins. Some articles would let you know how to add custom

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

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

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

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

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

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

[sphinx-users] Sphinx-1.5.1 has been released

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

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

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

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

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

Re: [sphinx-users] Call for translation updates

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

Re: [sphinx-users] Call for translation updates

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

Re: [sphinx-users] Call for translation updates

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

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

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

[sphinx-users] Sphinx-1.4.9 has been released

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

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

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

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

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

[sphinx-users] Re: ReadTheDocs colour customization

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Re: [sphinx-users] Sphinx-1.4.7 released

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

[sphinx-users] Sphinx-1.4.7 released

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

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

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

[sphinx-users] Re: formatting rst file

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

[sphinx-users] Re: formatting rst file

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

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

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

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

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

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

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

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

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

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

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

[sphinx-users] Re: Custom JSON output?

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

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

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

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

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

<    1   2   3   4   5   6   >