Skip to content

Commit

Permalink
conf cli update
Browse files Browse the repository at this point in the history
  • Loading branch information
git-jamil committed Jul 3, 2024
1 parent cc59c15 commit 6b3429f
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 16 deletions.
16 changes: 8 additions & 8 deletions docs/advanced/user_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ You can also specify a config file on the command line via ``--config-file``.

.. code-block:: bash
dxh_py --config-file /home/audreyr/my-custom-config.yaml dxh_py
dxh_py --config-file /home/devxhub/my-custom-config.yaml dxh_py
Or you can set the ``dxh_py_CONFIG`` environment variable:

.. code-block:: bash
export dxh_py_CONFIG=/home/audreyr/my-custom-config.yaml
export dxh_py_CONFIG=/home/devxhub/my-custom-config.yaml
If you wish to stick to the built-in config and not load any user config file at all, use the CLI option ``--default-config`` instead.
Preventing dxh_py from loading user settings is crucial for writing integration tests in an isolated environment.
Expand All @@ -30,11 +30,11 @@ Example user config:
.. code-block:: yaml
default_context:
full_name: "Audrey Roy"
email: "audreyr@example.com"
github_username: "audreyr"
dxh_pys_dir: "/home/audreyr/my-custom-dxh_pys-dir/"
replay_dir: "/home/audreyr/my-custom-replay-dir/"
full_name: "DEVxHUB"
email: "tech@devxhub.com"
github_username: "devxhub"
dxh_pys_dir: "/home/devxhub/my-custom-dxh_pys-dir/"
replay_dir: "/home/devxhub/my-custom-replay-dir/"
abbreviations:
pp: https://github.com/devxhub/dxh_py.git
gh: https://github.com/{0}.git
Expand All @@ -54,7 +54,7 @@ Possible settings are:
A list of abbreviations for dxh_pys.
Abbreviations can be simple aliases for a repo name, or can be used as a prefix, in the form ``abbr:suffix``.
Any suffix will be inserted into the expansion in place of the text ``{0}``, using standard Python string formatting.
With the above aliases, you could use the ``dxh_py`` template simply by saying ``dxh_py pp``, or ``dxh_py gh:audreyr/dxh_py``.
With the above aliases, you could use the ``dxh_py`` template simply by saying ``dxh_py pp``, or ``dxh_py gh:devxhub/dxh_py``.
The ``gh`` (GitHub), ``bb`` (Bitbucket), and ``gl`` (Gitlab) abbreviations shown above are actually **built in**, and can be used without defining them yourself.

Read also: :ref:`injecting-extra-content`
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@

# General information about the project.
project = 'dxh_py'
copyright = '2013-2022, Audrey Roy and dxh_py community'
copyright = '2024, Devxhub and dxh_py community'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -218,7 +218,7 @@
'index',
'dxh_py.tex',
'dxh_py Documentation',
'Audrey Roy and dxh_py community',
'Devxhub and dxh_py community',
'manual',
),
]
Expand Down Expand Up @@ -253,7 +253,7 @@
'index',
'dxh_py',
'dxh_py Documentation',
['Audrey Roy and dxh_py community'],
['Devxhub and dxh_py community'],
1,
)
]
Expand All @@ -272,7 +272,7 @@
'index',
'dxh_py',
'dxh_py Documentation',
'Audrey Roy and dxh_py community',
'Devxhub and dxh_py community',
'dxh_py',
'Creates projects from project templates',
'Miscellaneous',
Expand Down
3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.. dxh_py documentation master file, created by
sphinx-quickstart on Thu Jul 11 11:31:49 2013.
.. dxh_py documentation master file.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down
1 change: 0 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ repository::

$ dxh_py https://github.com/devxhub/dxh_py.git
$ dxh_py git+ssh://[email protected]/devxhub/dxh_py.git
$ dxh_py hg+ssh://[email protected]/audreyr/dxh_py

You will be prompted to enter a bunch of project config values. (These are
defined in the project's `dxh_py.json`.)
Expand Down
2 changes: 1 addition & 1 deletion dxh_py/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ def main(
dxh_py is free and open source software, developed and managed by
volunteers. If you would like to help out or fund the project, please get
in touch at https://github.com/dxh_py/dxh_py.
in touch at https://github.com/devxhub/dxh_py.
"""
# Commands that should work without arguments
if list_installed:
Expand Down

0 comments on commit 6b3429f

Please sign in to comment.