Skip to content

Commit

Permalink
Configure Read The Docs (#251)
Browse files Browse the repository at this point in the history
* Add a ReadTheDocs config file

* Make the link unnamed

* Drop the duplicate module entry in Sphinx docs

* Stop referring to a non-existent static dir in doc
  • Loading branch information
webknjaz committed Nov 9, 2022
1 parent a0c03c1 commit 93bec6f
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 4 deletions.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
# for details

version: 2

sphinx:
builder: dirhtml
configuration: docs/conf.py
fail_on_warning: true

build:
os: ubuntu-22.04
tools:
python: >-
3.11
python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt
system_packages: false

...
2 changes: 0 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ TOML File
TOML Items
----------

.. module:: tomlkit.items

.. automodule:: tomlkit.items
:show-inheritance:
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_static_path = []
2 changes: 1 addition & 1 deletion tomlkit/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def string(
boolean flags (e.g. ``literal=True`` and/or ``multiline=True``)
can be used for personalization.
For more information, please check the spec: `https://toml.io/en/v1.0.0#string`_.
For more information, please check the spec: `<https://toml.io/en/v1.0.0#string>`__.
Common escaping rules will be applied for basic strings.
This can be controlled by explicitly setting ``escape=False``.
Expand Down

0 comments on commit 93bec6f

Please sign in to comment.