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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doc-zero
-Version: 0.1.1
+Version: 0.1.2
 Summary: Zero-configuration documentation generator for Python.
 Author: Fábio Macêdo Mendes
 Author-email: Fábio Macêdo Mendes <fabiomacedomendes@gmail.com>
@@ -22,14 +22,14 @@ Requires-Dist: typer>=0.27.0
 Maintainer: Fábio Macêdo Mendes
 Maintainer-email: Fábio Macêdo Mendes <fabiomacedomendes@gmail.com>
 Requires-Python: >=3.13
-Project-URL: Homepage, http://github.com/fabiommendes/zero-doc
-Project-URL: Repository, http://github.com/fabiommendes/zero-doc
-Project-URL: Documentation, https://zero-doc.readthedocs.io/
+Project-URL: Homepage, http://github.com/fabiommendes/doc0
+Project-URL: Repository, http://github.com/fabiommendes/doc0
+Project-URL: Documentation, https://doc-zero.readthedocs.io/
 Description-Content-Type: text/markdown
 
 # doc-zero
 
-`doc-zero` streamlines the process of writing documentation for your project. It is
+**Doc-zero** streamlines the process of writing documentation for your project. It is
 an opinionated and explicitly non-configurable tool that extracts information
 from your Python codebase and generates nice documentation with minimal effort.
 
@@ -40,28 +40,28 @@ but somewhat clunky to use and configure.
 
 ## How does it work?
 
-`doc0` introspect your codebase and creates a Sphinx project under the hood. In
+`doc-zero` introspect your codebase and creates a Sphinx project under the hood. In
 practice, if you have a relatively modern Python project (i.e., it assumes the
 existence of pyproject.toml) just type
 
 ```bash
-$ doc0 build
+$ doc-zero build # or the doc0 alias
 ```
 
 in the project root and it will create and build the documentation under
-`<project-root>/docs`. In `doc0`, all your documentation resides either in the
+`<project-root>/docs`. In `doc-zero`, all your documentation resides either in the
 README.md file in your repository or inside the source code.
 
 You can also type
 
 ```bash
-$ doc0 serve
+$ doc-zero serve
 ```
 
 and
 
 ```bash
-doc0 test
+doc-zero test
 ```
 
 to run either the live server or to test the doctests inside the documentation.
@@ -69,16 +69,16 @@ to run either the live server or to test the doctests inside the documentation.
 
 ## Adding the documentation to your project
 
-Doc0 assumes your project is already documented using docstrings and that 
+Doc-zero assumes your project is already documented using docstrings and that 
 you have a README.md file in the project root. It will use those assets to
 generate the documentation and the necessary configurations to make it buildable
 with Sphinx and ready to be hosted to readthedocs.io. 
 
-The first step is to install `doc0` as a development dependency in your project. 
+The first step is to install `doc-zero` as a development dependency in your project. 
 You can do this by running
 
 ```bash
-$ pip install doc0
+$ pip install doc-zero
 ```
 
 or the equivalent command for the package manager of choice.
@@ -87,10 +87,10 @@ or the equivalent command for the package manager of choice.
 Then, the following command generates the documentation:
 
 ```bash
-$ doc0 build
+$ doc-zero build
 ```
 
-`doc0` always creates a module documentation for your toplevel module. It will
+`doc-zero` always creates a module documentation for your toplevel module. It will
 also scan all sub-modules and generate a documentation page if they satisfy the
 following conditions:
 
@@ -98,5 +98,5 @@ following conditions:
 * The module has a docstring.
 * The module defines a `__all__` variable that lists its public API.
 
-`doc0` only includes the public API in the generated documentation. 
+`doc-zero` only includes the public API in the generated documentation. 
 

{doc_zero-0.1.1 → doc_zero-0.1.2}/README.md

@@ -1,6 +1,6 @@
 # doc-zero
 
-`doc-zero` streamlines the process of writing documentation for your project. It is
+**Doc-zero** streamlines the process of writing documentation for your project. It is
 an opinionated and explicitly non-configurable tool that extracts information
 from your Python codebase and generates nice documentation with minimal effort.
 
@@ -11,28 +11,28 @@ but somewhat clunky to use and configure.
 
 ## How does it work?
 
-`doc0` introspect your codebase and creates a Sphinx project under the hood. In
+`doc-zero` introspect your codebase and creates a Sphinx project under the hood. In
 practice, if you have a relatively modern Python project (i.e., it assumes the
 existence of pyproject.toml) just type
 
 ```bash
-$ doc0 build
+$ doc-zero build # or the doc0 alias
 ```
 
 in the project root and it will create and build the documentation under
-`<project-root>/docs`. In `doc0`, all your documentation resides either in the
+`<project-root>/docs`. In `doc-zero`, all your documentation resides either in the
 README.md file in your repository or inside the source code.
 
 You can also type
 
 ```bash
-$ doc0 serve
+$ doc-zero serve
 ```
 
 and
 
 ```bash
-doc0 test
+doc-zero test
 ```
 
 to run either the live server or to test the doctests inside the documentation.
@@ -40,16 +40,16 @@ to run either the live server or to test the doctests inside the documentation.
 
 ## Adding the documentation to your project
 
-Doc0 assumes your project is already documented using docstrings and that 
+Doc-zero assumes your project is already documented using docstrings and that 
 you have a README.md file in the project root. It will use those assets to
 generate the documentation and the necessary configurations to make it buildable
 with Sphinx and ready to be hosted to readthedocs.io. 
 
-The first step is to install `doc0` as a development dependency in your project. 
+The first step is to install `doc-zero` as a development dependency in your project. 
 You can do this by running
 
 ```bash
-$ pip install doc0
+$ pip install doc-zero
 ```
 
 or the equivalent command for the package manager of choice.
@@ -58,10 +58,10 @@ or the equivalent command for the package manager of choice.
 Then, the following command generates the documentation:
 
 ```bash
-$ doc0 build
+$ doc-zero build
 ```
 
-`doc0` always creates a module documentation for your toplevel module. It will
+`doc-zero` always creates a module documentation for your toplevel module. It will
 also scan all sub-modules and generate a documentation page if they satisfy the
 following conditions:
 
@@ -69,5 +69,5 @@ following conditions:
 * The module has a docstring.
 * The module defines a `__all__` variable that lists its public API.
 
-`doc0` only includes the public API in the generated documentation. 
+`doc-zero` only includes the public API in the generated documentation. 
 

{doc_zero-0.1.1 → doc_zero-0.1.2}/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"doc0>={module_version('doc0')}")
+            req_path.write_text(f"doc-zero>={module_version('doc0')}")
 
     def build(self) -> None:
         """

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

@@ -1,6 +1,6 @@
 [project]
 name = "doc-zero"
-version = "0.1.1"
+version = "0.1.2"
 description = "Zero-configuration documentation generator for Python."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -33,9 +33,9 @@ name = "Fábio Macêdo Mendes"
 email = "fabiomacedomendes@gmail.com"
 
 [project.urls]
-Homepage = "http://github.com/fabiommendes/zero-doc"
-Repository = "http://github.com/fabiommendes/zero-doc"
-Documentation = "https://zero-doc.readthedocs.io/"
+Homepage = "http://github.com/fabiommendes/doc0"
+Repository = "http://github.com/fabiommendes/doc0"
+Documentation = "https://doc-zero.readthedocs.io/"
 
 [project.scripts]
 doc0 = "doc0.cli:main"
@@ -73,11 +73,11 @@ release = '''
 '''
 
 [tool.taskipy.tasks.docs]
-cmd = "sphinx-build -b html docs/source docs/build -n"
+cmd = "uv run doc-zero build"
 help = "Build HTML documentation"
 
 [tool.taskipy.tasks.docs-serve]
-cmd = "sphinx-autobuild docs/source docs/build -n"
+cmd = "uv run doc-zero serve"
 help = "Serve HTML documentation with live reload"
 
 [tool.doc-zero]

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

@@ -1,6 +1,6 @@
 [project]
 name = "doc-zero"
-version = "0.1.1"
+version = "0.1.2"
 description = "Zero-configuration documentation generator for Python."
 readme = "README.md"
 authors = [
@@ -31,9 +31,9 @@ classifiers = [
 license = "MIT"
 
 [project.urls]
-Homepage = "http://github.com/fabiommendes/zero-doc"
-Repository = "http://github.com/fabiommendes/zero-doc"
-Documentation = "https://zero-doc.readthedocs.io/"
+Homepage = "http://github.com/fabiommendes/doc0"
+Repository = "http://github.com/fabiommendes/doc0"
+Documentation = "https://doc-zero.readthedocs.io/"
 
 [project.scripts]
 doc0 = "doc0.cli:main"
@@ -61,8 +61,8 @@ source = ["doc0"]
 omit = ["doc0/__main__.py"]
 
 [tool.taskipy.tasks]
-docs = { cmd = "sphinx-build -b html docs/source docs/build -n", help = "Build HTML documentation" }
-docs-serve = { cmd = "sphinx-autobuild docs/source docs/build -n", help = "Serve HTML documentation with live reload" }
+docs = { cmd = "uv run doc-zero build", help = "Build HTML documentation" }
+docs-serve = { cmd = "uv run doc-zero serve", help = "Serve HTML documentation with live reload" }
 test = "pytest tests"
 coverage = "pytest tests --cov=doc0 --cov-report=term-missing"
 lint = "ruff check ."