Configure Read The Docs (#251)

* 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

GitOrigin-RevId: 93bec6f94f4fb4b6dedf57078fb0c73ab3b65c8e
Change-Id: Id7d5edbe71e10eaf09bbb2c80f05623972f2c391
4 files changed
tree: 02d5b1526a9ff34dbca7c1b1557bbfdc50e524c8
  1. .github/
  2. docs/
  3. tomlkit/
  4. .coveragerc
  5. .flake8
  6. .gitignore
  7. .gitmodules
  8. .pre-commit-config.yaml
  9. .readthedocs.yaml
  10. CHANGELOG.md
  11. LICENSE
  12. poetry.lock
  13. pyproject.toml
  14. README.md
  15. tox.ini
README.md

GitHub Release PyPI Version Python Versions License
Tests

TOML Kit - Style-preserving TOML library for Python

TOML Kit is a 1.0.0-compliant TOML library.

It includes a parser that preserves all comments, indentations, whitespace and internal element ordering, and makes them accessible and editable via an intuitive API.

You can also create new TOML documents from scratch using the provided helpers.

Part of the implementation has been adapted, improved and fixed from Molten.

Usage

See the documentation for more information.

Installation

If you are using Poetry, add tomlkit to your pyproject.toml file by using:

poetry add tomlkit

If not, you can use pip:

pip install tomlkit

Running tests

Please clone the repo with submodules with the following command git clone --recurse-submodules https://github.com/sdispater/tomlkit.git. We need the submodule - toml-test for running the tests.

You can run the tests with poetry run pytest -q tests