Fix documentation

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.readthedocs.yml

@@ -1,17 +1,14 @@
 version: 2
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.10"
-formats:
-  - htmlzip
-  - epub
-  - pdf
+    python: "3"
 python:
   install:
     - method: pip
       path: .
-      extra_requirements: ["docs"]
+      extra_requirements:
+        - docs
 sphinx:
   builder: html
   configuration: docs/conf.py

docs/changelog.rst

@@ -1,9 +1,13 @@
 Release History
 ===============
 
+v1.1.2 - (2022-10-30)
+---------------------
+- Fix editable classes not exported at root level
+
 v1.1.1 - (2022-09-10)
 ---------------------
-- Add missed `wheel` as test dependency
+- Add missed ``wheel`` as test dependency
 
 v1.1.0 - (2022-09-10)
 ---------------------

docs/index.rst

@@ -32,14 +32,26 @@ Build wheel requires
 ~~~~~~~~~~~~~~~~~~~~
 .. autoclass:: RequiresBuildWheelResult
 
+Editable requires
+~~~~~~~~~~~~~~~~~
+.. autoclass:: RequiresBuildEditableResult
+
 Wheel metadata
 ~~~~~~~~~~~~~~
 .. autoclass:: MetadataForBuildWheelResult
 
+Editable metadata
+~~~~~~~~~~~~~~~~~
+.. autoclass:: MetadataForBuildEditableResult
+
 Source distribution
 ~~~~~~~~~~~~~~~~~~~
 .. autoclass:: SdistResult
 
+Editable
+~~~~~~~~
+.. autoclass:: EditableResult
+
 Wheel
 ~~~~~
 .. autoclass:: WheelResult

src/pyproject_api/__init__.py

@@ -3,8 +3,11 @@
 from ._frontend import (
     BackendFailed,
     CmdStatus,
+    EditableResult,
     Frontend,
+    MetadataForBuildEditableResult,
     MetadataForBuildWheelResult,
+    RequiresBuildEditableResult,
     RequiresBuildSdistResult,
     RequiresBuildWheelResult,
     SdistResult,
@@ -23,8 +26,11 @@
     "CmdStatus",
     "RequiresBuildSdistResult",
     "RequiresBuildWheelResult",
+    "RequiresBuildEditableResult",
     "MetadataForBuildWheelResult",
+    "MetadataForBuildEditableResult",
     "SdistResult",
     "WheelResult",
+    "EditableResult",
     "SubprocessFrontend",
 ]

tox.ini

@@ -58,7 +58,7 @@ description = build documentation
 extras =
     docs
 commands =
-    sphinx-build -d "{envtmpdir}{/}doctree" docs "{toxworkdir}{/}docs_out" --color -b html {posargs}
+    sphinx-build -d "{envtmpdir}{/}doctree" docs "{toxworkdir}{/}docs_out" --color -b html {posargs} -W
     python -c 'print(r"documentation available under file://{toxworkdir}{/}docs_out{/}index.html")'
 
 [testenv:pkg_meta]