docs: fixes to config docs

0xbrayo · Feb 3, 2025 · 2b11a3c · 2b11a3c
1 parent 19895aa
commit 2b11a3c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/docs/config.rst b/docs/config.rst
@@ -10,6 +10,7 @@ It also supports environment variables for configuration, which take precedence
 
 The CLI also supports a variety of options that can be used to override both configuration values and environment variables.
 
+.. _global-config:
 
 Global config
 -------------
@@ -52,12 +53,11 @@ The ``prompt`` section contains options for the prompt.
 The ``env`` section contains environment variables that gptme will fall back to if they are not set in the shell environment. This is useful for setting the default model and API keys for :doc:`providers`.
 
 Environment Variables
-------------------------
+~~~~~~~~~~~~~~~~~~~~~
 
 Besides the configuration files, gptme supports several environment variables to control its behavior:
 
-Feature Flags
-~~~~~~~~~~~~~
+.. rubric:: Feature Flags
 
 - ``GPTME_CHECK`` - Enable precommit checks (default: true if ``.pre-commit-config.yaml`` present)
 - ``GPTME_COSTS`` - Enable cost reporting for API calls (default: false)
@@ -66,14 +66,12 @@ Feature Flags
 - ``GPTME_PATCH_RECOVERY`` - Return file content in error for non-matching patches (default: false)
 - ``GPTME_SUGGEST_LLM`` - Enable LLM-powered prompt completion (default: false)
 
-Tool Configuration
-~~~~~~~~~~~~~~~~~~
+.. rubric:: Tool Configuration
 
 - ``GPTME_TTS_VOICE`` - Set the voice to use for TTS
 - ``GPTME_VOICE_FINISH`` - Wait for TTS speech to finish before exiting (default: false)
 
-Paths
-~~~~~
+.. rubric:: Paths
 
 - ``GPTME_LOGS_HOME`` - Override the default logs folder location
 

diff --git a/docs/providers.rst b/docs/providers.rst
@@ -20,7 +20,7 @@ On first startup, if ``--model`` is not set, and no API keys are set in the conf
 
 You can list the models known to gptme using ``gptme '/models' - '/exit'``
 
-Use the ``[env]`` section in the ``gptme.toml`` :doc:`config` file to store API keys using the same format as the environment variables:
+Use the ``[env]`` section in the :ref:`global-config` file to store API keys using the same format as the environment variables:
 
 - ``OPENAI_API_KEY="your-api-key"``
 - ``ANTHROPIC_API_KEY="your-api-key"``