Skip to content

Commit

Permalink
doc: Append pattern of configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Apr 4, 2024
1 parent 338a7bd commit 04e2ebd
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 3 deletions.
43 changes: 43 additions & 0 deletions doc/advanced/config-file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
=========================
Extra configuration files
=========================

age supports other files excepted for `.age.toml` to manage configuration.

Order of finding
================

age check "these are exiets" and "this includes configuration of age".
It use first valid file for configuration .

1. ``.age.toml``
2. ``Cargo.toml``
3. ``pyproject.toml``

File and section
================

``.age.toml``
-------------

Standard configuration file of ``age``.

Configuration values are managed on top-level sesciont.

``Cargo.toml``
--------------

Manifest file of Rust project.

``age`` refers ``package.metadata.age`` of file.

.. note:: See spec of file on `"The Cargo Book" <https://doc.rust-lang.org/cargo/reference/manifest.html>`_.

``pyproject.toml``
------------------

Metadata management file of Python project.

``age`` refers ``tool.age`` of file.

.. note:: See `spec of file <https://packaging.python.org/en/latest/specifications/pyproject-toml/>`_.
10 changes: 7 additions & 3 deletions doc/advanced/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
===============
Advanced usages
===============
==============
Advanced usage
==============

There are some extra usecases.

.. toctree::
:maxdepth: 2

workspace
config-file

0 comments on commit 04e2ebd

Please sign in to comment.