danwos
commented
7 months ago Thanks for the bug report :+1:
From the first look, numpydoc seems to put the content inside a table, which column configuration is not correct. We need to check the built single HTML file, how the HTML-code looks for this part.
Maybe it is a simple CSS fix, by using the right selector.
I am using numpydoc style for my documentation. Everything seems okay, except for a few warnings when running
sphinx-build -M simplepdf docs/source/ docs/build/ -a:Sphinx output
``` Running Sphinx v7.2.6 making output directory... done Setting theme to simplepdf_theme Generating css files from scss-templates [autosummary] generating autosummary for: api.rst, breakage.rst, countersink.rst, index.rst, manager.rst, readme.md, utils.rst loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv... myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True) building [mo]: all of 0 po files writing output... building [simplepdf]: all source files updating environment: [new config] 7 added, 0 changed, 0 removed reading sources... [100%] utils /home/However, my pdf looks like this in some sections. It is also not consistent, as this width varies from one section to another.
Here is my config:
conf.py
``` # Configuration file for the Sphinx documentation builder. import os import sys from importlib.metadata import metadata from datetime import datetime sys.path.insert(0, os.path.abspath('../../')) # -- Project information project = 'datasys-online' project_slug = project.lower() author = metadata(project.lower())['Author-email'].split('<')[0][:-1] version = metadata(project.lower())['Version'] release = version copyright = f'{datetime.now().year}, {author}' # -- General configuration extensions = [ 'sphinx.ext.duration', 'sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'sphinx_copybutton', 'numpydoc', 'sphinx.ext.autodoc.typehints', 'myst_parser', # For markdown support 'sphinx.ext.autosectionlabel', 'sphinx_tabs.tabs', 'sphinx.ext.viewcode', 'sphinx_markdown_tables', 'sphinx.ext.napoleon', 'sphinx_simplepdf', ] # SimplePDF Settings simplepdf_vars = { 'primary': '#333333', 'links': '#FF3333', } intersphinx_mapping = { 'python': ('https://docs.python.org/3/', None), 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), } intersphinx_disabled_domains = ['std'] templates_path = ['_templates'] # -- Options for HTML output html_theme = 'sphinx_rtd_theme' html_theme_options = { 'prev_next_buttons_location': None, # Add this to show TOC with singlehtml 'collapse_navigation': False, } html_show_sourcelink = False # -- Options for EPUB output epub_show_urls = 'footnote' # Configure autodoc to generate documentation for both class and module docstrings autodoc_default_options = { 'members': True, 'undoc-members': False, # 'no-show-inheritance': True, } # Prevent numpydoc from generating both class and __init__ docstrings numpydoc_show_class_members = False ```