Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent rst spacing between our other projects #54

Merged
merged 1 commit into from
Jul 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Contributors

.. code-block:: bash

$ git shortlog -s | cut -c8-
$ git shortlog -s | cut -c8-

.. _`@retr0h`: https://github.com/retr0h
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Install the test framework `Tox`_.

.. code-block:: bash

$ pip install tox
$ pip install tox

Unit
----
Expand All @@ -31,7 +31,7 @@ Unit tests are invoked by `Tox`_.

.. code-block:: bash

$ tox
$ tox

Formatting
==========
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand Down
84 changes: 42 additions & 42 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,89 +8,89 @@ 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.

.. 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
========
Expand All @@ -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
=============
Expand Down