[sphinx-users] Vertical space after latex command
I like to put macro definitions at the top of my latex files. It seems that
sphinx generates empty vertical space when I do this in rst files. Attached
is a conf.py and index.rst file that demonstrates this problem:
Is there some place I can put a set of latex macro definitions and not have
this problem ?
--
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/5e3ae8c2-d593-4afc-b628-1bf1ff2bdb76n%40googlegroups.com.
# For conf.py documentation see
# http://www.sphinx-doc.org/en/master/config
#
project = 'latex_space'
extensions = [
'sphinx.ext.mathjax',
]
exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store',
]
:math:`\newcommand{\B}[1]{{\bf #1}}`
Vertical Space After Latex Command
==
I often put macros definitions at the top of my latex files; e.g,
I have put the following definition at the top of this rst file:
| \:math\: \`\\newcommand{\\B}[1]{{\\bf #1}}\`
This latex command has no output, but it causes more white space to be placed
before the title in the html version of this file (as generated by sphinx).
If you delete the first line of this file (which containts the latex command)
the title in the html version will move up.
[sphinx-users] Clean up created HTML from bad file structure
I'll start off saying my apologies for the lack of knowledge, I am new to sphinx-doc. I have some documentation I made in markdown. I didn't do a great job doing setup beforehand, because I wanted to see how sphinx would output what I had. I figured I'd fix it after the fact. So I built was able to successfully clean my files so they show up how I would like, but there is leftover HTML files from when I first build. For example, I fix file1.md and I had another file2.md in the directory. There was a html page made for file2.md, but I don't need it anymore. Is there a way for sphinx to automatically clean what isn't present anymore? -- 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/98ca5751-643a-4208-ab05-9d7c271d0a87n%40googlegroups.com.
Re: [sphinx-users] Add more details to sphinx-generated API reference
Sorry. I don't know that. There many kinds of extensions in the world. So there might be an expected one. Thanks, Takeshi KOMIYA 2020年8月3日(月) 22:57 Markus Löning : > > Thanks Takeshi for the reply. Any other way to do this with sphinx if we > would give up the auto summary extension? > > On Monday, 3 August 2020 14:55:32 UTC+1, Komiya Takeshi wrote: >> >> It seems this pages uses autosummary extension. If so, there no way to >> add table columns for autosummary-table. >> You need to make a your own custom directive. >> >> Thanks, >> Takeshi KOMIYA >> >> 2020年8月3日(月) 19:26 Markus Löning : >> > >> > Hi all, >> > >> > Currently, when we generate our API reference we basically get a table >> > with two columns, one for the class name and one for the description (the >> > first line of the init docstring) (see >> > https://sktime.org/api_reference.html) >> > >> > Is there a way to add another column to it? >> > >> > We'd like to display the GitHub handle of the author/maintainer of the >> > class to make it easier for people to contact the right person and to give >> > our authors/maintainer more visibility. >> > >> > Could we use __author__ information in the Python files for that? >> > >> > Thanks for your help >> > >> > Markus >> > >> > -- >> > 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...@googlegroups.com. >> > To view this discussion on the web visit >> > https://groups.google.com/d/msgid/sphinx-users/666ab01f-cadb-495c-ad63-7b78ab4ef857o%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/ba625903-7184-43ce-9981-ca0be61e567eo%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/CAFmkQAOxAzDL4TgXSKAo7fo7vhf_wd997P%3Di%3DE02N3CiarOtAg%40mail.gmail.com.
Re: [sphinx-users] Add more details to sphinx-generated API reference
Thanks Takeshi for the reply. Any other way to do this with sphinx if we would give up the auto summary extension? On Monday, 3 August 2020 14:55:32 UTC+1, Komiya Takeshi wrote: > > It seems this pages uses autosummary extension. If so, there no way to > add table columns for autosummary-table. > You need to make a your own custom directive. > > Thanks, > Takeshi KOMIYA > > 2020年8月3日(月) 19:26 Markus Löning >: > > > > Hi all, > > > > Currently, when we generate our API reference we basically get a table > with two columns, one for the class name and one for the description (the > first line of the init docstring) (see > https://sktime.org/api_reference.html) > > > > Is there a way to add another column to it? > > > > We'd like to display the GitHub handle of the author/maintainer of the > class to make it easier for people to contact the right person and to give > our authors/maintainer more visibility. > > > > Could we use __author__ information in the Python files for that? > > > > Thanks for your help > > > > Markus > > > > -- > > 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...@googlegroups.com . > > To view this discussion on the web visit > https://groups.google.com/d/msgid/sphinx-users/666ab01f-cadb-495c-ad63-7b78ab4ef857o%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/ba625903-7184-43ce-9981-ca0be61e567eo%40googlegroups.com.
Re: [sphinx-users] Add more details to sphinx-generated API reference
It seems this pages uses autosummary extension. If so, there no way to add table columns for autosummary-table. You need to make a your own custom directive. Thanks, Takeshi KOMIYA 2020年8月3日(月) 19:26 Markus Löning : > > Hi all, > > Currently, when we generate our API reference we basically get a table with > two columns, one for the class name and one for the description (the first > line of the init docstring) (see https://sktime.org/api_reference.html) > > Is there a way to add another column to it? > > We'd like to display the GitHub handle of the author/maintainer of the class > to make it easier for people to contact the right person and to give our > authors/maintainer more visibility. > > Could we use __author__ information in the Python files for that? > > Thanks for your help > > Markus > > -- > 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/666ab01f-cadb-495c-ad63-7b78ab4ef857o%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/CAFmkQANuv%2BVBPinoGx%2BpqzcDbc5ocLMvs4sf_qdHkxExe%2BDv2g%40mail.gmail.com.
[sphinx-users] Add more details to sphinx-generated API reference
Hi all, Currently, when we generate our API reference we basically get a table with two columns, one for the class name and one for the description (the first line of the init docstring) (see https://sktime.org/api_reference.html) Is there a way to add another column to it? We'd like to display the GitHub handle of the author/maintainer of the class to make it easier for people to contact the right person and to give our authors/maintainer more visibility. Could we use __author__ information in the Python files for that? Thanks for your help Markus -- 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/666ab01f-cadb-495c-ad63-7b78ab4ef857o%40googlegroups.com.
