diff --git a/AUTHORS.rst b/AUTHORS.rst index db4dfd5..5e6dd13 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -15,6 +15,6 @@ Contributors .. code-block:: bash - $ git shortlog -s | cut -c8- + $ git shortlog -s | cut -c8- .. _`@retr0h`: https://github.com/retr0h diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 96ccbf5..e72b929 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -22,7 +22,7 @@ Install the test framework `Tox`_. .. code-block:: bash - $ pip install tox + $ pip install tox Unit ---- @@ -31,7 +31,7 @@ Unit tests are invoked by `Tox`_. .. code-block:: bash - $ tox + $ tox Formatting ========== @@ -42,7 +42,7 @@ From the root for the project, run: .. code-block:: bash - $ tox -e format + $ tox -e format .. _`YAPF`: https://github.com/google/yapf .. _`Tox`: https://tox.readthedocs.io/en/latest diff --git a/README.rst b/README.rst index 5b2e7a6..c19e3ba 100644 --- a/README.rst +++ b/README.rst @@ -23,13 +23,13 @@ Install gilt using pip: .. code-block:: bash - $ pip install python-gilt + $ pip install python-gilt Overlay remote repositories and/or files into the destinations provided. .. code-block:: bash - $ gilt --debug overlay + $ gilt --debug overlay Documentation ============= diff --git a/doc/source/index.rst b/doc/source/index.rst index 383ffb0..bee6b8e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,13 +8,13 @@ Overlay a remote repository into the destination provided. .. code-block:: yaml :caption: gilt.yml - - git: https://github.com/retr0h/ansible-etcd.git - version: master - dst: roles/retr0h.ansible-etcd/ + - git: https://github.com/retr0h/ansible-etcd.git + version: master + dst: roles/retr0h.ansible-etcd/ .. code-block:: bash - $ gilt overlay + $ gilt overlay Overlay files from a remote repository into the destinations provided. @@ -22,75 +22,75 @@ Overlay files from a remote repository into the destinations provided. .. code-block:: yaml :caption: gilt.yml - - git: https://github.com/lorin/openstack-ansible-modules.git - version: master - files: - - src: "*_manage" - dst: library/ - - src: nova_quota - dst: library/ - - src: neutron_router - dst: library/neutron_router.py + - git: https://github.com/lorin/openstack-ansible-modules.git + version: master + files: + - src: "*_manage" + dst: library/ + - src: nova_quota + dst: library/ + - src: neutron_router + dst: library/neutron_router.py .. code-block:: bash - $ gilt overlay + $ gilt overlay Overlay a directory from a remote repository into the destination provided. .. code-block:: yaml :caption: gilt.yml - - git: https://github.com/blueboxgroup/ursula.git - version: master - files: - - src: roles/logging - dst: roles/blueboxgroup.logging/ + - git: https://github.com/blueboxgroup/ursula.git + version: master + files: + - src: roles/logging + dst: roles/blueboxgroup.logging/ .. code-block:: bash - $ gilt overlay + $ gilt overlay Optionally, override gilt's cache location (defaults to ~/.gilt): .. code-block:: bash - $ export GILT_CACHE_DIRECTORY=~/my-gilt-cache + $ export GILT_CACHE_DIRECTORY=~/my-gilt-cache Overlay files and a directory and run post-overlay commands. .. code-block:: yaml :caption: gilt.yml - - git: https://github.com/example/subproject.git - version: master - files: - - src: subtool/test - dst: ext/subtool.test/ - post_commands: - - make + - git: https://github.com/example/subproject.git + version: master + files: + - src: subtool/test + dst: ext/subtool.test/ + post_commands: + - make - - git: https://github.com/example/subtool2.git - version: master - dst: ext/subtool2/ - post_commands: - - make + - git: https://github.com/example/subtool2.git + version: master + dst: ext/subtool2/ + post_commands: + - make .. code-block:: bash - $ gilt overlay + $ gilt overlay Display the git commands being executed. .. code-block:: bash - $ gilt --debug overlay + $ gilt --debug overlay Use an alternate config file (default `gilt.yml`). .. code-block:: bash - $ gilt --config /path/to/gilt.yml overlay + $ gilt --config /path/to/gilt.yml overlay Molecule ======== @@ -100,18 +100,18 @@ Integrates with `Molecule`_ as an `Ansible Galaxy`_ CLI replacement. Update .. code-block:: yaml - --- - dependency: - name: shell - command: gilt overlay + --- + dependency: + name: shell + command: gilt overlay Testing ======= .. code-block:: bash - $ pip install tox - $ tox + $ pip install tox + $ tox Similar Tools =============