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

"Title underline too short" warning in a lot of API docs #487

Closed
yousefmoazzam opened this issue Oct 15, 2024 · 0 comments · Fixed by #494
Closed

"Title underline too short" warning in a lot of API docs #487

yousefmoazzam opened this issue Oct 15, 2024 · 0 comments · Fixed by #494
Labels
documentation Improvements or additions to documentation

Comments

@yousefmoazzam
Copy link
Collaborator

From browsing the various warnings in the docs build (noted in #468), I noticed these types of warnings for basically every module in httomo:

:mod:`httomo.sweep_runner.param_sweep_yaml_loader`
============================================
/dls/science/users/twi18192/httomo/docs/source/api/httomo.sweep_runner.side_output_manager.rst:2: WARNING: Title underline too short.

It seems this is due to the hardcoded length of the underline in the template used to generate the API docs rst files from*:

{%- if show_headings %}:mod:`{{ basename }}`
============================================
{%- endif %}
.. automodule:: {{ qualname }}
{%- for option in automodule_options %}
:{{ option }}:
{%- endfor %}

*The -t flag in the docs build script is providing that template I think:

sphinx-apidoc -feT -t=$DIR/source/_templates -o $DIR/source/api $DIR/../httomo

@yousefmoazzam yousefmoazzam added the documentation Improvements or additions to documentation label Oct 15, 2024
@yousefmoazzam yousefmoazzam changed the title "Underline too short" warning in a lot of API docs "Title underline too short" warning in a lot of API docs Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant