Vertical space after latex command

29 views
Skip to first unread message

bradley...@gmail.com

unread,
Aug 3, 2020, 7:41:39 PM8/3/20
to sphinx-users

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 ?

conf.py
index.rst

Matthias Geier

unread,
Aug 11, 2020, 6:54:34 AM8/11/20
to sphinx...@googlegroups.com
On Tue, Aug 4, 2020 at 1:41 AM bradley...@gmail.com wrote:
>
> 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 ?

It's a bit of a hack, but you can try something like this:

############################

.. raw:: html

<div hidden>

:math:`\newcommand{\B}[1]{{\bf #1}}`

.. raw:: html

</div>

############################

Alternatively, you can do it with a CSS class, which makes the .rst
file a bit simpler:

############################
.. rst-class:: hidden

:math:`\newcommand{\B}[1]{{\bf #1}}`
############################

... but you need to defined some custom CSS:

############################
.hidden {
display: none;
}
############################

cheers,
Matthias

bradley...@gmail.com

unread,
Aug 12, 2020, 7:34:26 AM8/12/20
to sphinx-users
Thanks for the suggestion. I used the instructions on
https://blog.readthedocs.com/custom-css-and-js-in-sphinx/
to add a style sheet and it worked.

To be specific, I added the file _static/css/custom.css with the following text:

    /* preamble used to add hidden class */

    .hidden {
        display: None;
    }

I changed my latex macro to

    .. rst-class:: hidden

        :math:`\newcommand{\B}[1]{ {\bf #1} }`


I added the following at the end of my conf.py
 
    # -- These folders are copied to the documentation's HTML output ------------
    html_static_path = [ '_static' ]

    # -- These paths are either relative to html_static_path --------------------
    # or fully qualified paths (eg. https://...)
    html_css_files = [
        'css/custom.css',
    ]

Matthias Geier

unread,
Aug 13, 2020, 10:24:11 AM8/13/20
to sphinx...@googlegroups.com
On Wed, Aug 12, 2020 at 1:34 PM bradley...@gmail.com wrote:
>
> Thanks for the suggestion. I used the instructions on
> https://blog.readthedocs.com/custom-css-and-js-in-sphinx/
> to add a style sheet and it worked.

I'm glad it worked for you!

> To be specific, I added the file _static/css/custom.css with the following text:
>
> /* preamble used to add hidden class */
>
> .hidden {
> display: None;
> }
>
> I changed my latex macro to
>
> .. rst-class:: hidden
>
> :math:`\newcommand{\B}[1]{ {\bf #1} }`

Please note that the indentation after the "rst-class" directive is
not necessary (I'm not sure whether it's harmful).

The "rst-class" directive simply applies a CSS class to the following
element, it doesn't create its own element.

cheers,
Matthias
> --
> 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/4664d0c2-14c8-4430-87a7-626d9336304an%40googlegroups.com.

Daniel Scott

unread,
Nov 25, 2020, 10:35:05 PM11/25/20
to sphinx...@googlegroups.com
On Mon, Aug 3, 2020, 4:41 PM bradley...@gmail.com <bradley...@gmail.com> wrote:

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...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages