Changes to ensure that documentation can be generated locally with sphinx-build

Author: tim-littlefair

.gitignore

@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+## Entries below this point added by Tim Littlefair, Nov 2025-
+
+# A directory which can be used as a target for experimental output
+_work
+

docs/conf.py

@@ -18,12 +18,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "ai-python docs"
-copyright = "2022, Daniel Ciborowski"
-author = "Daniel Ciborowski"
+project = "tl-python-package-template"
+copyright = "2025, Tim Littlefair"
+author = "Tim Littlefair"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+release = "0.0.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -60,7 +60,9 @@
 # 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"]
+# Presently commented out to avoid a warning because template project does not
+# have a populated .docs/_static subdirectory.
+# html_static_path = ["_static"]
 
 # Napoleon settings
 napoleon_include_init_with_doc = True

docs/index.rst

@@ -1,14 +1,20 @@
-.. ai-python docs documentation master file, created by
-   sphinx-quickstart on Thu May  5 14:06:45 2022.
+.. created by sphinx-quickstart on Thu May  5 14:06:45 2022
+   Amended by Tim Littlefair, November 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to ai-python docs's documentation!
-==========================================
+Tim Littlefair's Python Package Template
+========================================
+
+If you use this repository as a template for your project,
+please amend the heading above to reflect your own project's
+identity.
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
+
    modules
 
 

docs/tl_python_package_template.hello_world.rst

@@ -1,29 +1,22 @@
 tl\_python\_package\_template package
 =====================================
 
-Subpackages
------------
 
-.. toctree::
-   :maxdepth: 4
-
-   tl_python_package_template.hello_world
-
-Submodules
-----------
-
-tl\_python\_package\_template.setup module
-------------------------------------------
+Module contents
+---------------
 
-.. automodule:: tl_python_package_template.setup
+.. automodule:: tl_python_package_template
    :members:
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
+Submodules
+----------
 
-.. automodule:: tl_python_package_template
+tl\_python\_package\_template.hello\_world module
+-------------------------------------------------
+
+.. automodule:: tl_python_package_template.hello_world
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:

docs/tl_python_package_template.rst

@@ -1,8 +1,18 @@
 #   -------------------------------------------------------------
-#   Copyright (c) Microsoft Corporation. All rights reserved.
+#   Original text Copyright (c) Microsoft Corporation. All rights reserved.
+#   Modified text Copyright (c) Tim Littlefair. All rights reserved.
 #   Licensed under the MIT License. See LICENSE in project root for information.
 #   -------------------------------------------------------------
-"""Python Package Template"""
+"""Tim Littlefair's Python Package Template
+
+If you use this repository as a template for your project,
+please rename the top-level module directory under ./src
+containing the file __init__.py to reflect your own project's
+identity.
+
+Renaming the module directory will trigger a requirement for
+the import statement in ./src/test/test_members.py to be
+updated to match the new package name."""
 from __future__ import annotations
 
-__version__ = "0.0.2"
+__version__ = "0.0.0"