profile
viewpoint

lehmannro/assert.sh 431

bash unit testing framework

lehmannro/libleipzig-python 19

wortschatz.uni-leipzig.de binding

lehmannro/commithero 9

Achievements for Programmers

lehmannro/pyhkal2 7

IRC bot with bling bling

lehmannro/faketerm 4

terminal presentation viewer

lehmannro/cardshuffle 3

Real-time Strategy Game simulation of enemy wizard parties

lehmannro/pymsl 3

a MSL Interpreter in Python

lehmannro/matchr 2

regular expressions match combinator

CommitCommentEvent

issue commentsphinx-doc/sphinx

linkcheck could also check local (internal) links

Docs for hyperlinking with docutils and Sphinx:

https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/roles.html#ref-role

https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/basics.html#hyperlinks

https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/roles.html#role-doc :


:doc:`this`
:doc:`this one <this>`

^^ that'll work in Sphinx but not in a GH rst render. Could you omit the extension from the link? (There's a conf.py option to remove the .HTML from sphinx-generated links: /a/b.html. -> /a/b)

`anchor text <this>`_

Trying to remember what the trailing double underscore does for hyperlinks?

`anchor text <this>`__
anntzer

comment created time in a day

issue commentsphinx-doc/sphinx

linkcheck could also check local (internal) links

https://github.com/sphinx-doc/sphinx/blob/master/sphinx/builders/linkcheck.py


.. index: this
.. _that:
.. _this:

This
=====

:ref:`this` - which references ``.. _this:`` - works between all docs included in the sphinx build.

:ref:`that` does as well.

:ref:`also <this>`
:ref:`also <that>`

`this`_ works because there's a "this" heading 

`this <this.html>`_
`this <this.rst>`_
`this <this>`_

`this <this.html>`__
`this <this.rst>`__
`this <this>`__

This will log an error about the duplicate reference if it's in any doc in the build:

.. _this:

anntzer

comment created time in a day

issue commentsphinx-doc/sphinx

linkcheck could also check local (internal) links

Apologies if this is a bit off-topic, but I noticed that linkcheck is reporting broken links for all my local links. I suspect it's due to a problem with how my team is using local links.

Example: "overview.rst" links to "detail.rst" like so: see `details <./detail.html>`_

The HTML output is fine, but linkcheck fails because it looks for a file named detail.html, but locally there is only detail.rst.

Is the "right way" to solve this to use document cross-references instead of links?

Thank you!

anntzer

comment created time in a day

PR opened sphinx-doc/sphinx

Fix nonascii_srcdir to work when non-ascii directories aren't supported

Previously, the nonascii_srcdir in tests/test_build.py contained some logic to attempt to handle the case where non-ascii directories aren't supported, but it did not actually work because it fails to copy the test sources to the temporary directory.

With this commit, the following test invocation, which previously failed, now pases:

LANG=en_US.iso8859-1 python -m pytest test_build.py

+2 -0

0 comment

1 changed file

pr created time in a day

pull request commentsphinx-doc/sphinx

Support testing from read-only filesystems

Note: it seems like this should be merged into the master branch as well, assuming it is deemed acceptable for this branch. Does that happen automatically or should I create a separate pull request?

jbms

comment created time in a day

PR opened sphinx-doc/sphinx

Support testing from read-only filesystems

Currently, tests fail if run from a read-only filesystem because the temporary directory trees copied from the source tree are marked read-only by shutil.copytree.

This change fixes that by ensuring directories created sphinx.testing.path.copytree are always writable.

+9 -0

0 comment

1 changed file

pr created time in a day

PR opened sphinx-doc/sphinx

Allow user to use url to reference html logo & favicon

Subject: Allow user to use url to reference html logo & favicon

<!-- Before posting a pull request, please choose a appropriate branch:

  • Breaking changes: master
  • Critical or severe bugs: X.Y.Z
  • Others: X.Y

For more details, see https://www.sphinx-doc.org/en/master/devguide.html#branch-model -->

Feature or Bugfix

<!-- please choose -->

  • Feature

Purpose

  • To give user the possibility to use url to reference html logo and favicon. If a scheme is specified in the configuration file, the resource isn't copied as a a static file but simply referenced by its url.

Detail

  • html logo & favicon reference attributes are now determined when config values are processed. In html layouts, the directory _static/ does no longer prefix the html logo & favicon reference. Instead, when checking config values, the builder add the _static/ prefix is added if the scheme is empty. Otherwise, the config value is taken as the reference.
  • It could impact users who use custom html layouts

Relates

  • Closes #2018

This is my first contribution, so don't hesitate to tell me if I'm doing it wrong

+26 -14

0 comment

6 changed files

pr created time in 2 days

issue commentsphinx-doc/sphinx

Exception thrown with some YAML

I tried v3.3.1 and get a different error:

sphinx-build -b html -d build/doctrees  -W source build/html
Running Sphinx v3.3.1
/doc/source/conf.py:404: RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.
  app.add_stylesheet('css/custom.css')
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 130 source files that are out of date
updating environment: [new config] 130 added, 0 changed, 0 removed
reading sources... [ 80%] monitoring/prometheus                                                                   
Extension error:
Handler <function rstjinja at 0x7f69245e1dc0> for event 'source-read' threw an exception (exception: unexpected '.')
make: *** [Makefile:53: html] Error 2

This is the snipped causing the failure:

.. code-block:: yaml

   process_names:
   - name: ood-pun
     comm:
     - nginx
     - Passenger
     - Passenger NodeA
     - PassengerAgent
     - ruby
   - name: "{{.Comm}}:{{.Username}}"
     cmdline:
     - ".+"

If I remove part and just have the following there is no error:

.. code-block:: yaml

   process_names:
   - name: ood-pun
     comm:
     - nginx
     - Passenger
     - Passenger NodeA
     - PassengerAgent
     - ruby
treydock

comment created time in 2 days

pull request commentsphinx-doc/sphinx

domain: c: fix warning for intersphinx targets

@jakobandersen Have you had a chance to look into this?

utzig

comment created time in 2 days

issue commentsphinx-doc/sphinx

sphinx-apidoc ignores subfolder with filename starting with underscore as subpackage in toctree for main package

The problem persists if the package itself contains an underscore in its name. I know that, PEP8 discourages the presence of underscores in package names:

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

But could it be possibile to fix this too? Thanks

a-shrivastava

comment created time in 2 days

startededgelesssys/marblerun

started time in 2 days

pull request commentsphinx-doc/sphinx

Fix #8285: napoleon can use PEP526 annotations

My pleasure !

QuentinSoubeyran

comment created time in 3 days

push eventsphinx-doc/sphinx

Takeshi KOMIYA

commit sha 6d24579f400c735c1c999fdc602ebc9316b5ced8

Fix #8352: std domain: Failed to parse an option that starts with bracket

view details

Takeshi KOMIYA

commit sha 9cf28264917800534e56a92c1fa5c1196c73e73f

Merge pull request #8506 from tk0miya/8352_option_startswith_bracket Fix #8352: std domain: Failed to parse an option that starts with bracket

view details

push time in 3 days

issue closedsphinx-doc/sphinx

Sphinx 3.2 complains about option:: syntax that earlier versions accepted

Sphinx 3.2 complains about use of the option:: directive that earlier versions accepted without complaint.

The QEMU documentation includes this:

.. option:: [enable=]PATTERN

   Immediately enable events matching *PATTERN*

as part of the documentation of the command line options of one of its programs. Earlier versions of Sphinx were fine with this, but Sphinx 3.2 complains:

Warning, treated as error:
../../docs/qemu-option-trace.rst.inc:4:Malformed option description '[enable=]PATTERN', should look like "opt", "-opt args", "--opt args", "/opt args" or "+opt args"

Sphinx ideally shouldn't change in ways that break the building of documentation that worked in older versions, because this makes it unworkably difficult to have documentation that builds with whatever the Linux distro's sphinx-build is.

The error message suggests that Sphinx has a very restrictive idea of what option syntax is; it would be better if it just accepted any string, because not all programs and OSes have option syntax that matches the limited list the error message indicates.

closed time in 3 days

pm215

PR merged sphinx-doc/sphinx

Fix #8352: std domain: Failed to parse an option that starts with bracket bug domains:std

Feature or Bugfix

  • Bugfix

Purpose

  • refs: #8352
+29 -1

0 comment

3 changed files

tk0miya

pr closed time in 3 days

push eventsphinx-doc/sphinx

Takeshi KOMIYA

commit sha 6a88e64fd0e7504cd83a21d9f0d17063d31ed935

refactor: Register events for HTML builders in the HTML builder module

view details

Takeshi KOMIYA

commit sha cafb8bfe922ca51650d92693d61e358df7b112b8

Merge pull request #8507 from tk0miya/refactor_html_events_registration refactor: Register events for HTML builders in the HTML builder module

view details

push time in 3 days

PR merged sphinx-doc/sphinx

refactor: Register events for HTML builders in the HTML builder module html refactoring

Feature or Bugfix

  • Refactoring
+4 -2

0 comment

2 changed files

tk0miya

pr closed time in 3 days

issue commentsphinx-doc/sphinx

Images and figures can't have absolute paths: leading slash is removed at build

I don't have much time to investigate yet but please notice that:

  • The behavior changed recently. All my images were working before and they do not anymore.
  • Currently if I put ../_static/image.png I have the weird resulting path source/../_static/image.png which does not work. The only thing that works is /../_static/image.png which seems weird to me.

Does the problem come from the fact that I have sys.path.insert(0, os.path.abspath('..')) in my config?

jilljenn

comment created time in 3 days

issue commentsphinx-doc/sphinx

Add support for rate limit detection / retries @ linkcheck

@webknjaz Please let me know why do you want callbacks (flexibility)? Do you have any troublesome links? I still don't understand why you need such a feature.

webknjaz

comment created time in 3 days

PR opened sphinx-doc/sphinx

Fix #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese enhancement latex

Feature or Bugfix

  • Feature

Purpose

  • Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese docs (refs: #4186, #6841). uplatex is able to build a document without conversion character encoding internally. It allows using unicode characters in documents. Additionally, uplatex is compatible with platex (current default latex_engine for Japanese docs).
  • This changes the default latex_engine for Japanese document to uplatex.
  • refs: #8508
+9 -3

0 comment

3 changed files

pr created time in 3 days

issue openedsphinx-doc/sphinx

Use uplatex for default latex_engine for Japanese docs

Is your feature request related to a problem? Please describe. Use uplatex for default latex_engine for Japanese docs.

Describe the solution you'd like Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese docs (refs: https://github.com/sphinx-doc/sphinx/issues/4186, https://github.com/sphinx-doc/sphinx/pull/6841). uplatex is able to build a document without conversion character encoding internally. It allows using unicode characters in documents. Additionally, uplatex is compatible with platex (current default latex_engine for Japanese docs).

Describe alternatives you've considered Nothing.

Additional context Nothing.

created time in 3 days

push eventsphinx-doc/sphinx

Takeshi KOMIYA

commit sha bb63f030346829d05997efc3ec4713b3c937f3d5

Fix #8503: autoattribute could not create document for a GenericAlias

view details

Takeshi KOMIYA

commit sha aa84eea08bc8c10c0250ee495f69b173a5ff397e

Merge pull request #8504 from tk0miya/deprecate_GenericAliasDocumenter Fix #8503: autoattribute could not create document for a GenericAlias

view details

push time in 3 days

issue closedsphinx-doc/sphinx

autoattribute could not create document for a GenericAliase as class attributes correctly

Describe the bug autoattribute could not create document for a GenericAliase as class attributes correctly

To Reproduce

# example.py
class Foo:
    attr = List[int]
# index.rst
.. autoattribute:: example.Foo.attr

The build succeeded. But docstring is not shown.

Expected behavior

Document should be generated successfully like when I used automodule.

Your project N/A

Screenshots N/A

Environment info

  • OS: Mac
  • Python version: 3.9.0
  • Sphinx version: HEAD of 3.x
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: Nothing

Additional context Nothing

closed time in 3 days

tk0miya

PR merged sphinx-doc/sphinx

Fix #8503: autoattribute could not create document for a GenericAlias autodoc dependencies

Feature or Bugfix

  • Bugfix

Purpose

  • refs: #8503
+128 -34

0 comment

9 changed files

tk0miya

pr closed time in 3 days

push eventsphinx-doc/sphinx

Takeshi KOMIYA

commit sha 65ca7aa0c9e23dbe25dc49bf57131175be882186

Fix #8501: autosummary: summary extraction splits text after "el at." Add "el at." to the list of abbreviations.

view details

Takeshi KOMIYA

commit sha c15c61ed64b3c9e0232fe07a366c98aa229e6286

Merge pull request #8505 from tk0miya/8501_extract_summary_el_at Fix #8501: autosummary: summary extraction splits text after "el at."

view details

push time in 3 days

issue closedsphinx-doc/sphinx

autosummary: summary extraction splits text after "el at." unexpectedly

Describe the bug autosummary: summary extraction split text after "el at."

To Reproduce see https://github.com/sphinx-doc/sphinx/issues/4563#issuecomment-734117342

closed time in 3 days

tk0miya

PR merged sphinx-doc/sphinx

Fix #8501: autosummary: summary extraction splits text after "el at." api autosummary

Feature or Bugfix

  • Bugfix

Purpose

  • Add "el at." to the list of abbreviations.
  • refs: #8501
+5 -1

0 comment

3 changed files

tk0miya

pr closed time in 3 days

push eventsphinx-doc/sphinx

Takeshi KOMIYA

commit sha adb8f971566649976e13c7c319e23d85b28e1a0c

refactor: autodoc: Move deprecated documenters to autodoc.deprecated package

view details

Takeshi KOMIYA

commit sha 233cdc106323941e92ff9a6c54d8fc1ef2821e50

Merge pull request #8502 from tk0miya/refactor_autodoc_depraction refactor: autodoc: Move deprecated documenters to autodoc.deprecated package

view details

push time in 3 days

PR merged sphinx-doc/sphinx

refactor: autodoc: Move deprecated documenters to autodoc.deprecated package autodoc refactoring

Feature or Bugfix

  • Refactoring
+120 -95

0 comment

2 changed files

tk0miya

pr closed time in 3 days

more