diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 47b7fd077..1c496947f 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -85,16 +85,7 @@ jobs: python -m pip install --upgrade pip python -m pip install --upgrade sphinx-lint - name: Lint documentation with sphinx-lint - run: > - sphinx-lint - --enable line-too-long - --max-line-length 85 - AUTHORS.rst - CHANGES.rst - CODE_OF_CONDUCT.rst - CONTRIBUTING.rst - README.rst - doc/ + run: make doclinter twine: runs-on: ubuntu-latest diff --git a/CHANGES.rst b/CHANGES.rst index df4caaef8..1f5ea7bd8 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -5042,8 +5042,8 @@ Features added * ``LATEXMKOPTS`` variable for the Makefile in ``$BUILDDIR/latex`` to pass options to ``latexmk`` when executing ``make latexpdf`` (refs #3695, #3720) -* Add a new event `env-check-consistency` to check consistency to extensions -* Add `Domain.check_consistency()` to check consistency +* Add a new event ``env-check-consistency`` to check consistency to extensions +* Add ``Domain.check_consistency()`` to check consistency Bugs fixed ---------- @@ -5273,7 +5273,7 @@ Features added * #3241: emit latex warning if buggy titlesec (ref #3210) * #3194: Refer the $MAKE environment variable to determine ``make`` command * Emit warning for nested numbered toctrees (refs: #3142) -* #978: `intersphinx_mapping` also allows a list as a parameter +* #978: ``intersphinx_mapping`` also allows a list as a parameter * #3340: (LaTeX) long lines in :dudir:`parsed-literal` are wrapped like in :rst:dir:`code-block`, inline math and footnotes are fully functional. @@ -5354,7 +5354,7 @@ Incompatible changes 1.5a1 * latex, package fancybox is not any longer a dependency of sphinx.sty -* Use ``'locales'`` as a default value of `locale_dirs` +* Use ``'locales'`` as a default value of ``locale_dirs`` * latex, package ifthen is not any longer a dependency of sphinx.sty * latex, style file does not modify fancyvrb's Verbatim (also available as OriginalVerbatim) but uses sphinxVerbatim for name of custom wrapper. @@ -5368,7 +5368,7 @@ Incompatible changes use ``px`` rather than ignore it. * latex: Separate stylesheets of pygments to independent .sty file * #2454: The filename of sourcelink is now changed. The value of - `html_sourcelink_suffix` will be appended to the original filename (like + ``html_sourcelink_suffix`` will be appended to the original filename (like ``index.rst.txt``). * ``sphinx.util.copy_static_entry()`` is now deprecated. Use ``sphinx.util.fileutil.copy_asset()`` instead. @@ -5454,10 +5454,10 @@ Features added * #2463, #2516: Add keywords of "meta" directive to search index * ``:maxdepth:`` option of toctree affects ``secnumdepth`` (ref: #2547) * #2575: Now ``sphinx.ext.graphviz`` allows ``:align:`` option -* Show warnings if unknown key is specified to `latex_elements` -* Show warnings if no domains match with `primary_domain` (ref: #2001) +* Show warnings if unknown key is specified to ``latex_elements`` +* Show warnings if no domains match with ``primary_domain`` (ref: #2001) * C++, show warnings when the kind of role is misleading for the kind - of target it refers to (e.g., using the `class` role for a function). + of target it refers to (e.g., using the ``class`` role for a function). * latex, writer abstracts more of text styling into customizable macros, e.g. the ``visit_emphasis`` will output ``\sphinxstyleemphasis`` rather than ``\emph`` (which may be in use elsewhere or in an added LaTeX package). See @@ -5486,12 +5486,12 @@ Features added * math: Add hyperlink marker to each equations in HTML output * Add new theme ``nonav`` that doesn't include any navigation links. This is for any help generator like qthelp. -* #2680: `sphinx.ext.todo` now emits warnings if `todo_emit_warnings` enabled. - Also, it emits an additional event named `todo-defined` to handle the TODO +* #2680: ``sphinx.ext.todo`` now emits warnings if ``todo_emit_warnings`` enabled. + Also, it emits an additional event named ``todo-defined`` to handle the TODO entries in 3rd party extensions. * Python domain signature parser now uses the xref mixin for 'exceptions', allowing exception classes to be autolinked. -* #2513: Add `latex_engine` to switch the LaTeX engine by conf.py +* #2513: Add ``latex_engine`` to switch the LaTeX engine by conf.py * #2682: C++, basic support for attributes (C++11 style and GNU style). The new configuration variables 'cpp_id_attributes' and 'cpp_paren_attributes' can be used to introduce custom attributes. @@ -5513,8 +5513,8 @@ Features added * #2926: EPUB3 builder supports vertical mode (``epub3_writing_mode`` option) * #2695: ``build_sphinx`` subcommand for setuptools handles exceptions as same as ``sphinx-build`` does -* #326: `numref` role can also refer sections -* #2916: `numref` role can also refer caption as an its linktext +* #326: ``numref`` role can also refer sections +* #2916: ``numref`` role can also refer caption as an its linktext 1.5a2 @@ -5567,8 +5567,8 @@ Bugs fixed * #2707: (latex) the column width is badly computed for tabular * #2799: Sphinx installs roles and directives automatically on importing sphinx module. Now Sphinx installs them on running application. -* `sphinx.ext.autodoc` crashes if target code imports * from mock modules - by `autodoc_mock_imports`. +* ``sphinx.ext.autodoc`` crashes if target code imports * from mock modules + by ``autodoc_mock_imports``. * #1953: ``Sphinx.add_node`` does not add handlers the translator installed by ``html_translator_class`` * #1797: text builder inserts blank line on top @@ -5591,7 +5591,7 @@ Bugs fixed * #3004: Invalid link types "top" and "up" are used * #3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4 * #3000: ``option`` directive generates invalid HTML anchors -* #2984: Invalid HTML has been generated if `html_split_index` enabled +* #2984: Invalid HTML has been generated if ``html_split_index`` enabled * #2986: themes/basic/defindex.html should be changed for html5 friendly * #2987: Invalid HTML has been generated if multiple IDs are assigned to a list * #2891: HTML search does not provide all the results @@ -5625,7 +5625,7 @@ Bugs fixed * #3069: Even if ``'babel'`` key is set to empty string, LaTeX output contains one ``\addto\captions...`` * #3123: user ``'babel'`` key setting is not obeyed anymore -* #3155: Fix JavaScript for `html_sourcelink_suffix` fails with IE and Opera +* #3155: Fix JavaScript for ``html_sourcelink_suffix`` fails with IE and Opera * #3085: keep current directory after breaking build documentation. Thanks to Timotheus Kampik. * #3181: pLaTeX crashes with a section contains endash @@ -5696,9 +5696,9 @@ Bugs fixed * Could not reference equations if ``:nowrap:`` option specified * #2873: code-block overflow in latex (due to commas) * #1060, #2056: sphinx.ext.intersphinx: broken links are generated if relative - paths are used in `intersphinx_mapping` + paths are used in ``intersphinx_mapping`` * #2931: code-block directive with same :caption: causes warning of duplicate - target. Now `code-block` and `literalinclude` does not define hyperlink + target. Now ``code-block`` and ``literalinclude`` does not define hyperlink target using its caption automatically. * #2962: latex: missing label of longtable * #2968: autodoc: show-inheritance option breaks docstrings @@ -5731,7 +5731,7 @@ Bugs fixed * #2833: Fix formatting instance annotations in ext.autodoc. * #1911: ``-D`` option of ``sphinx-build`` does not override the ``extensions`` variable -* #2789: `sphinx.ext.intersphinx` generates wrong hyperlinks if the inventory is +* #2789: ``sphinx.ext.intersphinx`` generates wrong hyperlinks if the inventory is given * parsing errors for caption of code-blocks are displayed in document (ref: #2845) @@ -5769,11 +5769,11 @@ Bugs fixed * #2676: (latex) Error with verbatim text in captions since Sphinx 1.4.4 * #2629: memoir class crashes LaTeX. Fixed by ``latex_keep_old_macro_names=False`` (ref 2675) -* #2684: `sphinx.ext.intersphinx` crashes with six-1.4.1 +* #2684: ``sphinx.ext.intersphinx`` crashes with six-1.4.1 * #2679: ``float`` package needed for ``'figure_align': 'H'`` latex option * #2671: image directive may lead to inconsistent spacing in pdf * #2705: ``toctree`` generates empty bullet_list if ``:titlesonly:`` specified -* #2479: `sphinx.ext.viewcode` uses python2 highlighter by default +* #2479: ``sphinx.ext.viewcode`` uses python2 highlighter by default * #2700: HtmlHelp builder has hard coded index.html * latex, since 1.4.4 inline literal text is followed by spurious space * #2722: C++, fix id generation for var/member declarations to include @@ -5782,13 +5782,13 @@ Bugs fixed indentation (fixed together with #2671) * #2733: since Sphinx 1.4.4 ``make latexpdf`` generates lots of hyperref warnings -* #2731: `sphinx.ext.autodoc` does not access propertymethods which raises any +* #2731: ``sphinx.ext.autodoc`` does not access propertymethods which raises any exceptions * #2666: C++, properly look up nested names involving constructors. * #2579: Could not refer a label including both spaces and colons via - `sphinx.ext.intersphinx` + ``sphinx.ext.intersphinx`` * #2718: Sphinx crashes if the document file is not readable -* #2699: hyperlinks in help HTMLs are broken if `html_file_suffix` is set +* #2699: hyperlinks in help HTMLs are broken if ``html_file_suffix`` is set * #2723: extra spaces in latex pdf output from multirow cell * #2735: latexpdf ``Underfull \hbox (badness 10000)`` warnings from title page * #2667: latex crashes if resized images appeared in section title @@ -5811,7 +5811,7 @@ Bugs fixed * Let LaTeX use straight quotes also in inline code (ref #2627) * #2351: latex crashes if enumerated lists are placed on footnotes * #2646: latex crashes if math contains twice empty lines -* #2480: `sphinx.ext.autodoc`: memory addresses were shown +* #2480: ``sphinx.ext.autodoc``: memory addresses were shown * latex: allow code-blocks appearing inside lists and quotes at maximal nesting depth (ref #777, #2624, #2651) * #2635: Latex code directives produce inconsistent frames based on viewing @@ -5838,7 +5838,7 @@ Bugs fixed * #2614: Some tables in PDF output will end up shifted if user sets non zero \parindent in preamble * #2602: URL redirection breaks the hyperlinks generated by - `sphinx.ext.intersphinx` + ``sphinx.ext.intersphinx`` * #2613: Show warnings if merged extensions are loaded * #2619: make sure amstext LaTeX package always loaded (ref: d657225, 488ee52, 9d82cad and #2615) @@ -5915,20 +5915,20 @@ Bugs fixed * #2521: generated Makefile causes BSD make crashed if sphinx-build not found * #2470: ``typing`` backport package causes autodoc errors with python 2.7 * ``sphinx.ext.intersphinx`` crashes if non-string value is used for key of - `intersphinx_mapping` -* #2518: `intersphinx_mapping` disallows non alphanumeric keys + ``intersphinx_mapping`` +* #2518: ``intersphinx_mapping`` disallows non alphanumeric keys * #2558: unpack error on devhelp builder * #2561: Info builder crashes when a footnote contains a link * #2565: The descriptions of objects generated by ``sphinx.ext.autosummary`` overflow lines at LaTeX writer * Extend pdflatex config in sphinx.sty to subparagraphs (ref: #2551) -* #2445: `rst_prolog` and `rst_epilog` affect to non reST sources +* #2445: ``rst_prolog`` and ``rst_epilog`` affect to non reST sources * #2576: ``sphinx.ext.imgmath`` crashes if subprocess raises error * #2577: ``sphinx.ext.imgmath``: Invalid argument are passed to dvisvgm * #2556: Xapian search does not work with Python 3 * #2581: The search doesn't work if language="es" (Spanish) * #2382: Adjust spacing after abbreviations on figure numbers in LaTeX writer -* #2383: The generated footnote by `latex_show_urls` overflows lines +* #2383: The generated footnote by ``latex_show_urls`` overflows lines * #2497, #2552: The label of search button does not fit for the button itself @@ -5938,7 +5938,7 @@ Release 1.4.1 (released Apr 12, 2016) Incompatible changes -------------------- -* The default format of `today_fmt` and `html_last_updated_fmt` is back to +* The default format of ``today_fmt`` and ``html_last_updated_fmt`` is back to strftime format again. Locale Date Markup Language is also supported for backward compatibility until Sphinx 1.5. @@ -5981,7 +5981,7 @@ Incompatible changes Refs #2087, #2086, #1845 and #2097. Thanks to Victor Zverovich. * #2231: Use DUrole instead of DUspan for custom roles in LaTeX writer. It enables to take title of roles as an argument of custom macros. -* #2022: 'Thumbs.db' and '.DS_Store' are added to `exclude_patterns` default +* #2022: 'Thumbs.db' and '.DS_Store' are added to ``exclude_patterns`` default values in conf.py that will be provided on sphinx-quickstart. * #2027, #2208: The ``html_title`` accepts string values only. And the ``None`` value cannot be accepted. @@ -6004,11 +6004,11 @@ Incompatible changes add ``highlight_language = "python"`` to conf.py. * `Locale Date Markup Language `_ like - ``"MMMM dd, YYYY"`` is default format for `today_fmt` and - `html_last_updated_fmt`. However strftime format like ``"%B %d, %Y"`` is also + ``"MMMM dd, YYYY"`` is default format for ``today_fmt`` and + ``html_last_updated_fmt``. However strftime format like ``"%B %d, %Y"`` is also supported for backward compatibility until Sphinx 1.5. Later format will be disabled from Sphinx 1.5. -* #2327: ``latex_use_parts`` is deprecated now. Use `latex_toplevel_sectioning` +* #2327: ``latex_use_parts`` is deprecated now. Use ``latex_toplevel_sectioning`` instead. * #2337: Use ``\url{URL}`` macro instead of ``\href{URL}{URL}`` in LaTeX writer. * #1498: manpage writer: don't make whole of item in definition list bold if it @@ -6079,14 +6079,14 @@ Features added * #2338: Define ``\titleref`` macro to redefine the style of ``title-reference`` roles. * Define ``\menuselection`` and ``\accelerator`` macros to redefine the style of - `menuselection` roles. + ``menuselection`` roles. * Define ``\crossref`` macro to redefine the style of references * #2301: Texts in the classic html theme should be hyphenated. * #2355: Define ``\termref`` macro to redefine the style of ``term`` roles. * Add :confval:`suppress_warnings` to suppress arbitrary warning message (experimental) * #2229: Fix no warning is given for unknown options -* #2327: Add `latex_toplevel_sectioning` to switch the top level sectioning of +* #2327: Add ``latex_toplevel_sectioning`` to switch the top level sectioning of LaTeX document. Bugs fixed @@ -6196,7 +6196,7 @@ Bugs fixed * #2247: Fix #2205 breaks make html for definition list with classifiers that contains regular-expression like string * #1565: Sphinx will now emit a warning that highlighting was skipped if the - syntax is incorrect for `code-block`, `literalinclude` and so on. + syntax is incorrect for ``code-block``, ``literalinclude`` and so on. * #2211: Fix paragraphs in table cell doesn't work in Latex output * #2253: ``:pyobject:`` option of ``literalinclude`` directive can't detect indented body block when the block starts with blank or comment lines. @@ -6343,12 +6343,12 @@ Bugs fixed * #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will raise UnicodeEncodeError. * #1974: UnboundLocalError: local variable 'domain' referenced before assignment - when using `any` role and `sphinx.ext.intersphinx` in same time. + when using ``any`` role and ``sphinx.ext.intersphinx`` in same time. * #2121: multiple words search doesn't find pages when words across on the page title and the page content. * #1884, #1885: plug-in html themes cannot inherit another plug-in theme. Thanks to Suzumizaki. -* #1818: `sphinx.ext.todo` directive generates broken html class attribute as +* #1818: ``sphinx.ext.todo`` directive generates broken html class attribute as 'admonition-' when :confval:`language` is specified with non-ASCII linguistic area like 'ru' or 'ja'. To fix this, now ``todo`` directive can use ``:class:`` option. @@ -6376,7 +6376,7 @@ Bugs fixed * #1771: automated .mo building doesn't work properly. * #1783: Autodoc: Python2 Allow unicode string in ``__all__``. Thanks to Jens Hedegaard Nielsen. -* #1781: Setting `html_domain_indices` to a list raises a type check warnings. +* #1781: Setting ``html_domain_indices`` to a list raises a type check warnings. Release 1.3 (released Mar 10, 2015) @@ -6395,7 +6395,7 @@ Features added * Add convenience directives and roles to the C++ domain: directive ``cpp:var`` as alias for ``cpp:member``, role ``:cpp:var`` as alias - for ``:cpp:member``, and role `any` for cross-reference to any C++ + for ``:cpp:member``, and role ``any`` for cross-reference to any C++ declaraction. #1577, #1744 * The :confval:`source_suffix` config value can now be a list of multiple suffixes. @@ -6437,9 +6437,9 @@ Incompatible changes * Dependency requirement updates: Docutils 0.11, Pygments 2.0 * The ``gettext_enables`` config value has been renamed to - `gettext_additional_targets`. + ``gettext_additional_targets``. * #1735: Use https://docs.python.org/ instead of ``http`` protocol. - It was used for `sphinx.ext.intersphinx` and some documentation. + It was used for ``sphinx.ext.intersphinx`` and some documentation. Features added -------------- @@ -6462,17 +6462,17 @@ Features added described in documentation. * HTML breadcrumb items tag has class "nav-item" and "nav-item-N" (like nav-item-0, 1, 2...). -* New option `sphinx-quickstart --use-make-mode` for generating Makefile that +* New option ``sphinx-quickstart --use-make-mode`` for generating Makefile that use sphinx-build make-mode. * #1235: i18n: several node can be translated if it is set to - `gettext_additional_targets` in conf.py. Supported nodes are: + ``gettext_additional_targets`` in conf.py. Supported nodes are: - 'literal-block' - 'doctest-block' - 'raw' - 'image' -* #1227: Add `html_scaled_image_link` config option to conf.py, to control +* #1227: Add ``html_scaled_image_link`` config option to conf.py, to control scaled image link. Bugs fixed @@ -6515,7 +6515,7 @@ Features added -------------- * #1597: Added possibility to return a new template name from - `html-page-context`. + ``html-page-context``. * PR#314, #1150: Configuration values are now checked for their type. A warning is raised if the configured and the default value do not have the same type and do not share a common non-trivial base class. @@ -6551,13 +6551,13 @@ Incompatible changes * PR#269, #1476: replace ```` tag by ````. User customized stylesheets should be updated If the css contain some styles for ``tt>`` tag. Thanks to Takeshi Komiya. -* #1543: `templates_path` is automatically added to - `exclude_patterns` to avoid reading autosummary rst templates in the +* #1543: ``templates_path`` is automatically added to + ``exclude_patterns`` to avoid reading autosummary rst templates in the templates directory. -* Custom domains should implement the new `Domain.resolve_any_xref` - method to make the `any` role work properly. +* Custom domains should implement the new ``Domain.resolve_any_xref`` + method to make the ``any`` role work properly. * gettext builder: gettext doesn't emit uuid information to generated pot files - by default. Please set ``True`` to `gettext_uuid` to emit uuid information. + by default. Please set ``True`` to ``gettext_uuid`` to emit uuid information. Additionally, if the ``python-levenshtein`` 3rd-party package is installed, it will improve the calculation time. * gettext builder: disable extracting/apply 'index' node by default. Please set @@ -6572,34 +6572,34 @@ Features added * Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring support. * Added support for parallel reading (parsing) of source files with the - `sphinx-build -j` option. Third-party extensions will need to be checked for + ``sphinx-build -j`` option. Third-party extensions will need to be checked for compatibility and may need to be adapted if they store information in the - build environment object. See `env-merge-info`. -* Added the `any` role that can be used to find a cross-reference of + build environment object. See ``env-merge-info``. +* Added the ``any`` role that can be used to find a cross-reference of *any* type in *any* domain. Custom domains should implement the new - `Domain.resolve_any_xref` method to make this work properly. + ``Domain.resolve_any_xref`` method to make this work properly. * Exception logs now contain the last 10 messages emitted by Sphinx. * Added support for extension versions (a string returned by ``setup()``, these can be shown in the traceback log files). Version requirements for extensions - can be specified in projects using the new `needs_extensions` config + can be specified in projects using the new ``needs_extensions`` config value. * Changing the default role within a document with the :dudir:`default-role` directive is now supported. * PR#214: Added stemming support for 14 languages, so that the built-in document search can now handle these. Thanks to Shibukawa Yoshiki. * PR#296, PR#303, #76: numfig feature: Assign numbers to figures, tables and - code-blocks. This feature is configured with `numfig`, `numfig_secnum_depth` - and `numfig_format`. Also `numref` role is available. Thanks to Takeshi + code-blocks. This feature is configured with ``numfig``, ``numfig_secnum_depth`` + and ``numfig_format``. Also ``numref`` role is available. Thanks to Takeshi Komiya. * PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields for Python. -* PR#184: Add `autodoc_mock_imports`, allowing to mock imports of +* PR#184: Add ``autodoc_mock_imports``, allowing to mock imports of external modules that need not be present when autodocumenting. * #925: Allow list-typed config values to be provided on the command line, like ``-D key=val1,val2``. -* #668: Allow line numbering of `code-block` and `literalinclude` directives +* #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives to start at an arbitrary line number, with a new ``lineno-start`` option. -* PR#172, PR#266: The `code-block` and `literalinclude` +* PR#172, PR#266: The ``code-block`` and ``literalinclude`` directives now can have a ``caption`` option that shows a filename before the code in the output. Thanks to Nasimul Haque, Takeshi Komiya. * Prompt for the document language in sphinx-quickstart. @@ -6619,12 +6619,12 @@ Features added and WAKAYAMA shirou. * PR#272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI. * Automatically compile ``*.mo`` files from ``*.po`` files when - `gettext_auto_build` is ``True`` (default) and ``*.po`` is newer than + ``gettext_auto_build`` is ``True`` (default) and ``*.po`` is newer than ``*.mo`` file. -* #623: `sphinx.ext.viewcode` supports imported function/class aliases. -* PR#275: `sphinx.ext.intersphinx` supports multiple target for the +* #623: ``sphinx.ext.viewcode`` supports imported function/class aliases. +* PR#275: ``sphinx.ext.intersphinx`` supports multiple target for the inventory. Thanks to Brigitta Sipocz. -* PR#261: Added the `env-before-read-docs` event that can be connected to modify +* PR#261: Added the ``env-before-read-docs`` event that can be connected to modify the order of documents before they are read by the environment. * #1284: Program options documented with :rst:dir:`option` can now start with ``+``. @@ -6634,7 +6634,7 @@ Features added Thanks to Takeshi Komiya. * #1344: add ``gettext_enables`` to enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation. -* PR#301, #1583: Allow the line numbering of the directive `literalinclude` to +* PR#301, #1583: Allow the line numbering of the directive ``literalinclude`` to match that of the included file, using a new ``lineno-match`` option. Thanks to Jeppe Pihl. * PR#299: add various options to sphinx-quickstart. Quiet mode option @@ -6651,7 +6651,7 @@ Bugs fixed * #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises AssertionError for correct type of argument. Thanks to rikoman. * #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or - `makevar`. + ``makevar``. * PR#235: comment db schema of websupport lacked a length of the node_id field. Thanks to solos. * #1466,PR#241: Fix failure of the cpp domain parser to parse C+11 @@ -6687,8 +6687,8 @@ Bugs fixed qualified name. It should be rather easy to change this behaviour and potentially index by namespaces/classes as well. -* PR#258, #939: Add dedent option for `code-block` and - `literalinclude`. Thanks to Zafar Siddiqui. +* PR#258, #939: Add dedent option for ``code-block`` and + ``literalinclude``. Thanks to Zafar Siddiqui. * PR#268: Fix numbering section does not work at singlehtml mode. It still ad-hoc fix because there is a issue that section IDs are conflicted. Thanks to Takeshi Komiya. @@ -6696,10 +6696,10 @@ Bugs fixed Takeshi Komiya. * PR#274: Set its URL as a default title value if URL appears in toctree. Thanks to Takeshi Komiya. -* PR#276, #1381: `rfc` and `pep` roles support custom link +* PR#276, #1381: ``rfc`` and ``pep`` roles support custom link text. Thanks to Takeshi Komiya. * PR#277, #1513: highlights for function pointers in argument list of - `c:function`. Thanks to Takeshi Komiya. + ``c:function``. Thanks to Takeshi Komiya. * PR#278: Fix section entries were shown twice if toctree has been put under only directive. Thanks to Takeshi Komiya. * #1547: pgen2 tokenizer doesn't recognize ``...`` literal (Ellipsis for py3). @@ -6778,7 +6778,7 @@ Release 1.2.2 (released Mar 2, 2014) Bugs fixed ---------- -* PR#211: When checking for existence of the `html_logo` file, check +* PR#211: When checking for existence of the ``html_logo`` file, check the full relative path and not the basename. * PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring. * PR#213: Fix a missing import in the setup command. @@ -6818,7 +6818,7 @@ Bugs fixed This was caused by a change for #1138. * #1340: Can't search alphabetical words on the HTML quick search generated with language='ja'. -* #1319: Do not crash if the `html_logo` file does not exist. +* #1319: Do not crash if the ``html_logo`` file does not exist. * #603: Do not use the HTML-ized title for building the search index (that resulted in "literal" being found on every page with a literal in the title). @@ -6859,7 +6859,7 @@ Bugs fixed running Python version. * #1017: Be helpful and tell the user when the argument to :rst:dir:`option` does not match the required format. -* #1345: Fix two bugs with `nitpick_ignore`; now you don't have to +* #1345: Fix two bugs with ``nitpick_ignore``; now you don't have to remove the store environment for changes to have effect. * #1072: In the JS search, fix issues searching for upper-cased words by lowercasing words before stemming. @@ -6882,8 +6882,8 @@ Bugs fixed * #1300: Fix references not working in translated documents in some instances. * #1283: Fix a bug in the detection of changed files that would try to access doctrees of deleted documents. -* #1330: Fix `exclude_patterns` behavior with subdirectories in the - `html_static_path`. +* #1330: Fix ``exclude_patterns`` behavior with subdirectories in the + ``html_static_path``. * #1323: Fix emitting empty ``
    `` tags in the HTML writer, which is not valid HTML. * #1147: Don't emit a sidebar search box in the "singlehtml" builder. @@ -6982,7 +6982,7 @@ Features added * Support docutils.conf 'writers' and 'html4css1 writer' section in the HTML writer. The latex, manpage and texinfo writers also support their respective 'writers' sections. -* The new `html_extra_path` config value allows to specify directories +* The new ``html_extra_path`` config value allows to specify directories with files that should be copied directly to the HTML output directory. * Autodoc directives for module data and attributes now support an ``annotation`` option, so that the default display of the data/attribute @@ -7053,10 +7053,10 @@ Incompatible changes * Removed ``sphinx.util.compat.directive_dwim()`` and ``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0. -* PR#122: the files given in `latex_additional_files` now override TeX +* PR#122: the files given in ``latex_additional_files`` now override TeX files included by Sphinx, such as ``sphinx.sty``. -* PR#124: the node generated by `versionadded`, - `versionchanged` and `deprecated` directives now includes +* PR#124: the node generated by ``versionadded``, + ``versionchanged`` and ``deprecated`` directives now includes all added markup (such as "New in version X") as child nodes, and no additional text must be generated by writers. * PR#99: the :rst:dir:`seealso` directive now generates admonition nodes instead @@ -7110,7 +7110,7 @@ Features added asterisks ("*"). - The default value for the ``paragraphindent`` has been changed from 2 to 0 meaning that paragraphs are no longer indented by default. - - #1110: A new configuration value `texinfo_no_detailmenu` has been + - #1110: A new configuration value ``texinfo_no_detailmenu`` has been added for controlling whether a ``@detailmenu`` is added in the "Top" node's menu. - Detailed menus are no longer created except for the "Top" node. @@ -7119,16 +7119,16 @@ Features added * LaTeX builder: - - PR#115: Add ``'transition'`` item in `latex_elements` for + - PR#115: Add ``'transition'`` item in ``latex_elements`` for customizing how transitions are displayed. Thanks to Jeff Klukas. - PR#114: The LaTeX writer now includes the "cmap" package by default. The - ``'cmappkg'`` item in `latex_elements` can be used to control this. + ``'cmappkg'`` item in ``latex_elements`` can be used to control this. Thanks to Dmitry Shachnev. - - The ``'fontpkg'`` item in `latex_elements` now defaults to ``''`` + - The ``'fontpkg'`` item in ``latex_elements`` now defaults to ``''`` when the :confval:`language` uses the Cyrillic script. Suggested by Dmitry Shachnev. - - The `latex_documents`, `texinfo_documents`, and - `man_pages` configuration values will be set to default values based + - The ``latex_documents``, ``texinfo_documents``, and + ``man_pages`` configuration values will be set to default values based on the :confval:`master_doc` if not explicitly set in :file:`conf.py`. Previously, if these values were not set, no output would be generated by their respective builders. @@ -7147,13 +7147,13 @@ Features added :class:`~sphinx.builders.xml.XMLBuilder` and :class:`~sphinx.builders.xml.PseudoXMLBuilder`. - PR#45: The linkcheck builder now checks ``#anchor``\ s for existence. - - PR#123, #1106: Add `epub_use_index` configuration value. If - provided, it will be used instead of `html_use_index` for epub + - PR#123, #1106: Add ``epub_use_index`` configuration value. If + provided, it will be used instead of ``html_use_index`` for epub builder. - - PR#126: Add `epub_tocscope` configuration value. The setting + - PR#126: Add ``epub_tocscope`` configuration value. The setting controls the generation of the epub toc. The user can now also include hidden toc entries. - - PR#112: Add `epub_show_urls` configuration value. + - PR#112: Add ``epub_show_urls`` configuration value. * Extensions: @@ -7220,7 +7220,7 @@ Bugs fixed * #1127: Fix traceback when autodoc tries to tokenize a non-Python file. * #1126: Fix double-hyphen to en-dash conversion in wrong places such as command-line option names in LaTeX. -* #1123: Allow whitespaces in filenames given to `literalinclude`. +* #1123: Allow whitespaces in filenames given to ``literalinclude``. * #1120: Added improvements about i18n for themes "basic", "haiku" and "scrolls" that Sphinx built-in. Thanks to Leonardo J. Caballero G. * #1118: Updated Spanish translation. Thanks to Leonardo J. Caballero G. @@ -7228,7 +7228,7 @@ Bugs fixed * #1112: Avoid duplicate download files when referenced from documents in different ways (absolute/relative). * #1111: Fix failure to find uppercase words in search when - `html_search_language` is 'ja'. Thanks to Tomo Saito. + ``html_search_language`` is 'ja'. Thanks to Tomo Saito. * #1108: The text writer now correctly numbers enumerated lists with non-default start values (based on patch by Ewan Edwards). * #1102: Support multi-context "with" statements in autodoc. @@ -7357,7 +7357,7 @@ Release 1.1 (Oct 9, 2011) Incompatible changes -------------------- -* The `py:module` directive doesn't output its ``platform`` option +* The ``py:module`` directive doesn't output its ``platform`` option value anymore. (It was the only thing that the directive did output, and therefore quite inconsistent.) @@ -7393,7 +7393,7 @@ Features added :rst:dir:`toctree`\'s ``numbered`` option. - #586: Implemented improved :rst:dir:`glossary` markup which allows multiple terms per definition. - - #478: Added `py:decorator` directive to describe decorators. + - #478: Added ``py:decorator`` directive to describe decorators. - C++ domain now supports array definitions. - C++ domain now supports doc fields (``:param x:`` inside directives). - Section headings in :rst:dir:`only` directives are now correctly @@ -7449,8 +7449,8 @@ Features added - Added ``inline`` option to graphviz directives, and fixed the default (block-style) in LaTeX output. - #590: Added ``caption`` option to graphviz directives. - - #553: Added `testcleanup` blocks in the doctest extension. - - #594: `trim_doctest_flags` now also removes ```` + - #553: Added ``testcleanup`` blocks in the doctest extension. + - #594: ``trim_doctest_flags`` now also removes ```` indicators. - #367: Added automatic exclusion of hidden members in inheritance diagrams, and an option to selectively enable it. @@ -7527,7 +7527,7 @@ Release 1.0.8 (Sep 23, 2011) * #669: Respect the ``noindex`` flag option in py:module directives. * #675: Fix IndexErrors when including nonexisting lines with - `literalinclude`. + ``literalinclude``. * #676: Respect custom function/method parameter separator strings. @@ -7610,7 +7610,7 @@ Release 1.0.6 (Jan 04, 2011) * #570: Try decoding ``-D`` and ``-A`` command-line arguments with the locale's preferred encoding. -* #528: Observe `locale_dirs` when looking for the JS +* #528: Observe ``locale_dirs`` when looking for the JS translations file. * #574: Add special code for better support of Japanese documents @@ -7788,17 +7788,17 @@ Features added * Markup: - - The `menuselection` and `guilabel` roles now + - The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators. - New more compact doc field syntax is now recognized: ``:param type name: description``. - - Added ``tab-width`` option to `literalinclude` directive. + - Added ``tab-width`` option to ``literalinclude`` directive. - Added ``titlesonly`` option to :rst:dir:`toctree` directive. - Added the ``prepend`` and ``append`` options to the - `literalinclude` directive. + ``literalinclude`` directive. - #284: All docinfo metadata is now put into the document metadata, not just the author. - - The `ref` role can now also reference tables by caption. + - The ``ref`` role can now also reference tables by caption. - The :dudir:`include` directive now supports absolute paths, which are interpreted as relative to the source directory. - In the Python domain, references like ``:func:`.name``` now look for @@ -7806,28 +7806,28 @@ Features added * Configuration: - - Added `rst_prolog` config value. - - Added `html_secnumber_suffix` config value to control + - Added ``rst_prolog`` config value. + - Added ``html_secnumber_suffix`` config value to control section numbering format. - - Added `html_compact_lists` config value to control + - Added ``html_compact_lists`` config value to control Docutils' compact lists feature. - - The `html_sidebars` config value can now contain patterns + - The ``html_sidebars`` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered. That means that the builtin sidebar contents can be included only selectively. - - `html_static_path` can now contain single file entries. - - The new universal config value `exclude_patterns` makes the + - ``html_static_path`` can now contain single file entries. + - The new universal config value ``exclude_patterns`` makes the old ``unused_docs``, ``exclude_trees`` and ``exclude_dirnames`` obsolete. - - Added `html_output_encoding` config value. - - Added the `latex_docclass` config value and made the + - Added ``html_output_encoding`` config value. + - Added the ``latex_docclass`` config value and made the "twoside" documentclass option overridable by "oneside". - - Added the `trim_doctest_flags` config value, which is true + - Added the ``trim_doctest_flags`` config value, which is true by default. - - Added `html_show_copyright` config value. - - Added `latex_show_pagerefs` and `latex_show_urls` + - Added ``html_show_copyright`` config value. + - Added ``latex_show_pagerefs``` and ``latex_show_urls`` config values. - - The behavior of `html_file_suffix` changed slightly: the + - The behavior of ``html_file_suffix``` changed slightly: the empty string now means "no suffix" instead of "default suffix", use ``None`` for "default suffix". @@ -7869,7 +7869,7 @@ Features added * Extension API: - Added :event:`html-collect-pages`. - - Added `needs_sphinx` config value and + - Added ``needs_sphinx`` config value and :meth:`~sphinx.application.Sphinx.require_sphinx` application API method. - #200: Added :meth:`!add_stylesheet` @@ -7881,7 +7881,7 @@ Features added - Added the :mod:`~sphinx.ext.extlinks` extension. - Added support for source ordering of members in autodoc, with ``autodoc_member_order = 'bysource'``. - - Added `autodoc_default_flags` config value, which can be + - Added ``autodoc_default_flags`` config value, which can be used to select default flags for all autodoc directives. - Added a way for intersphinx to refer to named labels in other projects, and to specify the project you want to link to. @@ -7891,7 +7891,7 @@ Features added extension, thanks to Pauli Virtanen. - #309: The :mod:`~sphinx.ext.graphviz` extension can now output SVG instead of PNG images, controlled by the - `graphviz_output_format` config value. + ``graphviz_output_format`` config value. - Added ``alt`` option to :rst:dir:`graphviz` extension directives. - Added ``exclude`` argument to :func:`.autodoc.between`. diff --git a/Makefile b/Makefile index c2fc72387..74d2ede07 100644 --- a/Makefile +++ b/Makefile @@ -58,10 +58,9 @@ type-check: .PHONY: doclinter doclinter: - @sphinx-lint --enable all --max-line-length 85 --disable triple-backticks \ - -i CHANGES.rst -i LICENSE.rst -i EXAMPLES.rst \ - $(addprefix -i doc/, _build _static _templates _themes) \ - *.rst doc/ 2>&1 | sort -V + @sphinx-lint --enable all --disable triple-backticks --max-line-length 85 --sort-by filename,line \ + $(addprefix -i doc/, _build _static _templates _themes) \ + AUTHORS.rst CHANGES.rst CODE_OF_CONDUCT.rst CONTRIBUTING.rst README.rst doc/ .PHONY: test test: diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 35f17574d..207374e8f 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -199,7 +199,7 @@ To run JavaScript tests, use ``npm``:: .. tip:: - `karma` requires a Firefox binary to use as a test browser. + ``karma`` requires a Firefox binary to use as a test browser. For Unix-based systems, you can specify the path to the Firefox binary using::