doc-zero 0.1.2__tar.gz → 0.2.1__tar.gz

{doc_zero-0.1.2 → doc_zero-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doc-zero
-Version: 0.1.2
+Version: 0.2.1
 Summary: Zero-configuration documentation generator for Python.
 Author: Fábio Macêdo Mendes
 Author-email: Fábio Macêdo Mendes <fabiomacedomendes@gmail.com>

{doc_zero-0.1.2 → doc_zero-0.2.1}/doc0/base.py

@@ -128,7 +128,7 @@ class Doc0:
         # Write the requirements.txt file for Read the Docs, if it doesn't exist.
         req_path = self.root / "docs" / "requirements.txt"
         if not req_path.exists():
-            req_path.write_text(f"doc-zero>={module_version('doc0')}")
+            req_path.write_text(f"doc-zero>={module_version('doc-zero')}")
 
     def build(self) -> None:
         """
@@ -230,6 +230,7 @@ class Index:
     tutorials: Path | None = None
     how_to_guides: Path | None = None
     explanations: Path | None = None
+    user_guides: Path | None = None
 
     # Reference is concepts + api documentation
     concepts: Path | None = None
@@ -261,6 +262,7 @@ class Index:
 
         tutorials = select("tutorial")
         how_to_guides = select("how-to-guide")
+        user_guides = select("user-guide")
         explanations = select("explanation")
         concepts = select("concept")
 
@@ -269,6 +271,7 @@ class Index:
             tutorials=tutorials,
             how_to_guides=how_to_guides,
             explanations=explanations,
+            user_guides=user_guides,
             concepts=concepts,
             api_modules=module_names,
         )
@@ -298,6 +301,8 @@ class Index:
             yield f"   {self.tutorials.stem}"
         if self.how_to_guides:
             yield f"   {self.how_to_guides.stem}"
+        if self.user_guides:
+            yield f"   {self.user_guides.stem}"
         if self.explanations:
             yield f"   {self.explanations.stem}"
         if self.concepts:
@@ -350,13 +355,14 @@ class Conf:
 
         # Read the year from the Copyright notice in the LICENSE file.
         if (licence_file := Path(root / "LICENSE")).exists():
-            copyright = find_copyright(licence_file.read_text())
+            copyright = None
             if year is None:
                 try:
+                    copyright = find_copyright(licence_file.read_text())
                     year = int(copyright["year"])
                 except ValueError:
                     pass
-            if author is None:
+            if author is None and copyright is not None:
                 author = copyright["author"]
 
         return Conf(

{doc_zero-0.1.2 → doc_zero-0.2.1}/doc0/module.py

@@ -175,6 +175,7 @@ class Module:
         if inspect.isclass(obj):
             yield f".. autoclass:: {qualname}"
             yield "   :members:"
+            yield "   :member-order: bysource"
         elif inspect.isroutine(obj):
             yield f".. autofunction:: {qualname}"
         else:

{doc_zero-0.1.2 → doc_zero-0.2.1}/doc0/pyproject.py

@@ -126,11 +126,11 @@ class PyProject:
         return False
 
     def _is_toplevel_package_layout(self) -> bool:
-        package_dir = self.root / self.name
+        package_dir = self.root / normalize_package_name(self.name)
         return package_dir.is_dir() and (package_dir / "__init__.py").exists()
 
     def _find_uv_root_modules(self) -> Iterable[ModuleSpec]:
-        uv_conf = self.get("tool.uv.build-backend", type=dict)
+        uv_conf = self.get("tool.uv.build-backend", type=dict, default={})
         root = self.root / uv_conf.get("module-root", "")
         name = uv_conf.get("module-name")
         if name is None:
@@ -165,3 +165,16 @@ class PyProject:
 class Author(TypedDict):
     name: str
     email: NotRequired[str]
+
+
+def normalize_package_name(name: str) -> str:
+    """
+    Normalize a package name to a valid Python identifier.
+
+    Args:
+        name: The package name to normalize.
+
+    Returns:
+        The normalized package name.
+    """
+    return name.replace("-", "_").replace(".", "_")

{doc_zero-0.1.2 → doc_zero-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "doc-zero"
-version = "0.1.2"
+version = "0.2.1"
 description = "Zero-configuration documentation generator for Python."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -69,7 +69,8 @@ release = '''
         && uv run task test \
         && uv run task docs \
         && uv run task build \
-        && git add . && git commit -m "Release $(uv version)" && git tag "v$(uv version --short)"
+        && git add . && git commit -m "Release $(uv version)" && git tag "v$(uv version --short)" \
+        && git push && git push --tags
 '''
 
 [tool.taskipy.tasks.docs]

{doc_zero-0.1.2 → doc_zero-0.2.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "doc-zero"
-version = "0.1.2"
+version = "0.2.1"
 description = "Zero-configuration documentation generator for Python."
 readme = "README.md"
 authors = [
@@ -72,7 +72,8 @@ release = """
         && uv run task test \\
         && uv run task docs \\
         && uv run task build \\
-        && git add . && git commit -m "Release $(uv version)" && git tag "v$(uv version --short)"
+        && git add . && git commit -m "Release $(uv version)" && git tag "v$(uv version --short)" \\
+        && git push && git push --tags
 """
 
 [tool.doc-zero]