Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2022-02-20Collapse single line docstringsAdam Turner
2022-02-20Remove copyright and licence fieldsAdam Turner
2022-02-20Fix module docstring indentationAdam Turner
2022-02-20Fix module docstring first lineAdam Turner
2022-02-20Remove module titles in docstringsAdam Turner
2022-01-14Update sphinx/writers/texinfo.pydanieleades
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
2022-01-12address some unused loop control variables (B007)Daniel Eades
2022-01-02Migrate to Node.findall() from Node.traverse()Takeshi KOMIYA
Node.traverse() was marked as deprecated since docutils-0.18. Instead of it, Node.findall() has been added as successor of traverse(). This applies a patch to docutils-0.17 or older to be available Node.findall() and use it.
2022-01-01Merge branch '4.3.x' into 4.xTakeshi KOMIYA
2022-01-01A happy new year!Takeshi KOMIYA
2021-12-23Merge branch '4.x' into drop-translator-specific-unknown_visit-callsTakeshi KOMIYA
2021-12-11refactor: texinfo: Remove CR char from outputTakeshi KOMIYA
The CR character was added for readability of output. But it makes the texinfo writer a bit complicated. This removes it from output to keep our code simple (reducing conditions).
2021-12-11Merge branch '4.x' into fix-footnote-in-infoTakeshi KOMIYA
2021-12-11Merge branch '4.x' into texinfo-add-texinfo_emit_document_referencesTakeshi KOMIYA
2021-12-05drop translator-specific unknown_visit callsJames Knight
Removes the need for various translators from raising a `NotImplementedError` exception when missing support for a specific node type. docutils will already raise [1][2] a `NotImplementedError` exception for these cases. This help reduce the implementation inside Sphinx as well as prevents the possible undesired replication of unknown-node handling with third-party extensions [3]. In most cases, generating a warning message for an unsupported node type can be preferred. Providing an indication that a node is not supported can be easier for a user of Sphinx to understand a limitation of a builder over a generic "not implemented" exception. This commit takes the logging call which is already used by `texinfo` and applies it to the `SphinxTranslator` base class -- which any Sphinx translator implementation can use. [1]: https://repo.or.cz/docutils.git/blob/d169015ee0f412cffd69b33654d8a119d99bc0f3:/docutils/nodes.py#l2048 [2]: https://repo.or.cz/docutils.git/blob/53716a13b48128af6045139d3cd2909f61e7ed8e:/docutils/nodes.py#l1897 [3]: https://github.com/sphinx-doc/sphinx/issues/9921 Signed-off-by: James Knight <james.d.knight@live.com>
2021-11-12texinfo: simplify reference emission.Martin Liska
The commit adds a new config value 'texinfo_emit_document_references' that blocks the emission of inline references and make it better readable with legacy stand-alone reader ``info``. Before the change we emit: Default option value for @ref{e,,-Wshift-overflow3}. while with texinfo_emit_document_references == True: Default option value for -Wshift-overflow3. It addresses limitations mentioned in Sphinx' FAQ: https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
2021-11-08texinfo: improve variable in :samp: directivesMartin Liska
The following snippet: Show :samp:`Samp with a {variable}.` Ends in .info as: Show ‘Samp with a `variable'.’ Which is suboptimal and @var{variable} should be rather used. That results in ‘Samp with a VARIABLE.’.
2021-07-12texinfo: fix emission of @footnote directives.Martin Liska
Right now, labels are emitted as part of a @footnote directive. That results in e.g. Note1: (@footnote{@w{(1)} Future versions of GCC may zero-extend... }) which is incorrect and should be rather: Note1: (@footnote{Future versions of GCC may zero-extend...})
2021-04-12Decl styling, handle desc_inline in manpage and texinfoJakob Lykke Andersen
2021-03-13refactor: Use PEP-526 based variable annotation (sphinx.writers)Takeshi KOMIYA
2021-01-22Merge branch '3.x'Takeshi KOMIYA
2021-01-16refactor: Remove meaningless variable: attrsTakeshi KOMIYA
It would be better to use `name in node` and `node[name]` to check and access an attribute of the node instead of `node.attributes`.
2021-01-16Merge branch '3.x'Takeshi KOMIYA
2021-01-10refactor: Access config object from self directly in writersTakeshi KOMIYA
2021-01-01Merge branch '3.x'Takeshi KOMIYA
2021-01-01A happy new year!Takeshi KOMIYA
.. note:: $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \; $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
2020-11-11Merge branch '3.x'Takeshi KOMIYA
2020-11-11Sort imports with isortFrançois Freitag
Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
2020-11-02Merge branch '3.x'Takeshi KOMIYA
2020-11-01Merge branch '3.x' into 8183Takeshi KOMIYA
2020-10-24Merge branch '3.x'Takeshi KOMIYA
2020-10-18Correct a typo in texinfo.pyFelix Yan
2020-09-08Don't remove substitution_reference nodes (fix #7953)Brecht Machiels
SubstitutionDefinitionsRemover is now a SphinxPostTransform, only applied in the Sphinx builder, as was originally the case (see #4827).
2020-08-14Merge branch '3.x'Takeshi KOMIYA
2020-08-12Use node as locationYves Chevallier
2020-08-01Merge branch '3.x'Takeshi KOMIYA
2020-07-25Fix #7993: texinfo: a warning not supporting desc_signature_line node is shownTakeshi KOMIYA
2020-07-25Fix #7993: texinfo: TypeError is raised for nested object descriptionsTakeshi KOMIYA
The texinfo writer remembers the current desc node to render a desc_annotation node. This makes the mechanism robust to support nested object descriptions.
2020-07-04Merge branch '3.x'Takeshi KOMIYA
2020-06-14Fix exception causes all over the codebaseRam Rachum
2020-03-07Hello TYPE_CHECKING!Takeshi KOMIYA
2020-01-01Merge branch '2.0'Takeshi KOMIYA
2020-01-01A happy new year!Takeshi KOMIYA
2019-12-25Stop to use deprecated API: env.indexentriesTakeshi KOMIYA
2019-12-22Merge branch '2.0'Takeshi KOMIYA
2019-12-21Replace `a and b or c` by the more legible `b if a or c`.Antony Lee
2019-11-30Merge branch '2.0'Takeshi KOMIYA
2019-11-25Migrate to py3 style type annotation: sphinx.writers.texinfoTakeshi KOMIYA
2019-11-17Merge branch '2.0'Takeshi KOMIYA
2019-11-05Fix #6793: texinfo: Code examples broken following "sidebar"Takeshi KOMIYA