diff --git a/docs/conf.py b/docs/conf.py index a203c71..7960d5d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,7 +67,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/contributing.rst b/docs/contributing.rst index 5203931..d0c99eb 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -10,8 +10,8 @@ Questions If you have any question about the Python binding itself, you can -* `chat with us `_ on Discord, -* or `open an issue `_ on Github. +* `chat with us `__ on Discord, +* or `open an issue `__ on Github. If you have a question related to Guetzli, please look at the original Guetzli repository: @@ -23,7 +23,7 @@ Bugs ---- If you found a bug in the Python binding itself, please `open an issue -`_ on Github with as much +`__ on Github with as much information as possible: * How you installed PyGuetzli (Git, PyPI, Static build,...), @@ -32,19 +32,19 @@ information as possible: * ... If you found a bug in Guetzli, please `open an issue -`_ on its Github project. +`__ on its Github project. Pull Requests ------------- -Please consider `filing a bug `_ +Please consider `filing a bug `__ before starting to work on a new feature. This will allow us to discuss the best way to do it. This is, of course, not necessary if you just want to fix some typo in the documentation or small errors in the code. Please note that your code must pass tests and follow the coding style defined -by the `pep8 `_. +by the `pep8 `__. Installing Development Dependencies