Initial Configuration Override

Author: Behemyth

cppython/core/schema.py

@@ -104,10 +104,6 @@ def dynamic_data(cls, model: 'PEP621Configuration') -> 'PEP621Configuration':
         return model
 
 
-def _default_install_location() -> Path:
-    return Path.home() / '.cppython'
-
-
 class CPPythonData(CPPythonModel, extra='forbid'):
     """Resolved CPPython data with local and global configuration"""
 
@@ -268,20 +264,40 @@ class CPPythonGlobalConfiguration(CPPythonModel, extra='forbid'):
 class CPPythonLocalConfiguration(CPPythonModel, extra='forbid'):
     """Data required by the tool"""
 
+    configuration_path: Annotated[
+        Path | None,
+        Field(
+            description='The path to the configuration override file. If present, configuration found in the given'
+            ' directory will be preferred'
+        ),
+    ] = None
+
     install_path: Annotated[
         Path,
         Field(
             alias='install-path',
-            description='The global install path for the project',
+            description='The global install path for the project. Provider and generator plugins will be'
+            ' installed here.',
         ),
-    ] = _default_install_location()
-    tool_path: Annotated[Path, Field(alias='tool-path', description='The local tooling path for the project')] = Path(
-        'tool'
-    )
+    ] = Path.home() / '.cppython'
 
-    build_path: Annotated[Path, Field(alias='build-path', description='The local build path for the project')] = Path(
-        'build'
-    )
+    tool_path: Annotated[
+        Path,
+        Field(
+            alias='tool-path',
+            description='The local tooling path for the project. If the provider or generator need additional file'
+            ' support, this directory will be used',
+        ),
+    ] = Path('tool')
+
+    build_path: Annotated[
+        Path,
+        Field(
+            alias='build-path',
+            description='The local build path for the project. This is where the artifacts of the local C++ build'
+            ' process will be generated.',
+        ),
+    ] = Path('build')
 
     provider: Annotated[ProviderData, Field(description="Provider plugin data associated with 'provider_name")] = (
         ProviderData({})

docs/antora.yml

@@ -3,3 +3,4 @@ version: 0.1.0
 title: CPPython
 nav:
   - modules/ROOT/nav.adoc
+  - modules/tests/nav.adoc

docs/modules/ROOT/nav.adoc

@@ -1 +1,3 @@
+.CPPython
+* xref:index.adoc[]
 * xref:configuration.adoc[]

docs/modules/ROOT/pages/configuration.adoc

@@ -0,0 +1,16 @@
+= Configuration
+
+== Local Configuration
+
+Defined within the `pyproject.toml` file, the local configuration is used to customize the behavior of `cppython` for a specific project. The configuration is defined under the `[tool.cppython]` table.
+
+== Global Configuration
+
+Configuration exists in four places, each with a different default scope. The order of precedence is as follows:
+
+1. Configuration file override provided by the CLI or local `pyproject.toml` file.
+2. The local configuration file, `cppython.toml`, in the current working directory.
+3. The user level configuration file, `cppython.toml`, in the user's home directory.
+4. The global configuration file, `cppython.toml`, in the system configuration directory.
+
+Each configuration file that is found will be merged into the next configuration file found.

docs/modules/ROOT/pages/index.adoc

@@ -1 +1 @@
-= CPPython Website
+= Documentation for CPPython

docs/modules/tests/nav.adoc

@@ -1 +1,3 @@
+.CPPython
+* xref:index.adoc[]
 * xref:fixtures.adoc[]

docs/modules/tests/pages/index.adoc

@@ -0,0 +1 @@
+= Test Documentation