Skip to content

Commit

Permalink
Fixing non supported rst for Pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnPreston committed Jul 17, 2021
1 parent 7b01c7c commit db4f9f9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 25 deletions.
7 changes: 4 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,14 @@ publish-docs: docs
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: dist ## package and upload a release
twine check dist/*
twine upload dist/*

release-test: dist ## package and upload a release
twine check dist/* || echo Failed to validate release
twine upload --repository-url https://test.pypi.org/legacy/ dist/*

release: dist ## package and upload a release
twine upload dist/*

dist: clean ## builds source and wheel package
python setup.py sdist
python setup.py bdist_wheel
Expand Down
39 changes: 17 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ ECS Files Composer
.. image:: https://codebuild.eu-west-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiRWk3VUhxUi9peEdZRGs2cGFiTk5XM0VDK1FEQTBMN2JTdHh5b091NTVVdFd3RmpoM1lpdGkrTGtTZDJzVCt5dDBCc3Zsc0dXWHI5RHJRSG82UFJNdUJzPSIsIml2UGFyYW1ldGVyU3BlYyI6InJlYXlBWStNMDVZNEoyMnQiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main


.. seealso::

`Full official documentation <https://docs.files-composer.compose-x.io/index.html>`__

What does it do?
=================

Expand Down Expand Up @@ -47,6 +43,23 @@ files it needs.
How to use it ?
=================

`Full official documentation <https://docs.files-composer.compose-x.io/index.html>`__


Docker
----------------

.. code-block:: bash
docker run public.ecr.aws/compose-x/ecs-files-composer:${VERSION:-latest} -h
docker run -v $PWD:/ /var/tmp,:/public.ecr.aws/compose-x/ecs-files-composer:${VERSION:-latest} -f files.yaml
.. attention::

The default user is root to avoid running into issues when using chmod/chown and other commands.
Change behaviour at your own risks.


CLI
------------

Expand All @@ -65,21 +78,3 @@ CLI
Configuration for execution is in an SSM Parameter
--from-s3 S3_CONFIG Configuration for execution is in an S3
--role-arn ROLE_ARN The Role ARN to use for the configuration initialization
docker
----------------
.. code-block:: bash
docker run public.ecr.aws/compose-x/ecs-files-composer:${VERSION:-latest} -h
docker run -v $PWD:/ /var/tmp,:/public.ecr.aws/compose-x/ecs-files-composer:${VERSION:-latest} -f files.yaml
.. attention::
The default user is root to avoid running into issues when using chmod/chown and other commands.
Change behaviour at your own risks.
docker-compose
---------------
.. literalinclude:: docker-compose.yaml

0 comments on commit db4f9f9

Please sign in to comment.