Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rubric size #45

Closed
azmeuk opened this issue May 12, 2024 · 2 comments
Closed

Rubric size #45

azmeuk opened this issue May 12, 2024 · 2 comments

Comments

@azmeuk
Copy link

azmeuk commented May 12, 2024

I automatically generate some documentation for a click command with sphinx-cli. This makes a h1 for a level 1 command, a h2 for a sub-command, a h3 for a sub-sub-command and so on. For command options and arguments, it generates a <p class="rubric"> section containing the details.

commands.rst

.. click:: commands:lvl1cli
   :prog: lvl1cli
   :nested: full

commands.py

import click


@click.group()
def lvl1cli():
    """1st level command"""


@lvl1cli.group()
def lvl2cli():
    """2nd level command"""


@lvl2cli.group()
def lvl3cli():
    """3rd level command"""


@lvl3cli.command()
@click.argument('some-argument')
@click.option('--option', default=1, help='Some option')
def sub4cli():
    """4th level command"""

With shibuya the <p class="rubric"> section is bigger than the h4. For complex pages with a lot of commands, this become quite confusing.

Here is a simplified example, where Options and Argument are larger than sub4cli:
Screenshot 2024-05-12 at 17-25-01 lvl1cli

I would have expected the <p class="rubric"> section to be smaller than the related hX title in any situation.

What do you think?

@lepture
Copy link
Owner

lepture commented May 13, 2024

I can only set rubric and h5 h6 to 1rem.

@lepture
Copy link
Owner

lepture commented May 13, 2024

22bb89c

@lepture lepture closed this as completed May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants