Skip to content

Commit

Permalink
minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ngr committed Jul 19, 2019
1 parent b8b7bba commit bda0edb
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/contribution/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ Follow the PEP8_ but both classes and functions are padded with 2 empty lines.
Initialization
--------------

* Fork the repository: `https://github.com/bimpression/sosw`_
* Fork the repository: `<https://github.com/bimpression/sosw>`_

* Register Account in AWS: `SignUp`_
* Register Account in AWS: `SignUp <https://portal.aws.amazon.com/billing/signup#/start>`_

* Run `pipenv sync --dev` to setup your virtual environment and download the required dependencies
* Run ``pipenv sync --dev`` to setup your virtual environment and download the required dependencies

* If you are not familiar with CloudFormation, we highly recommend at least learning the basics from `the tutorial`_.

* Follow the :ref:`Installation Guidelines` to setup your environment.

* Create Sandbox Lambda.
* Create some Sandbox Lambda.

* Play with it.

Expand All @@ -54,11 +54,10 @@ Initialization

.. _the example: https://raw.githubusercontent.com/bimpression/sosw/docme/docs/yaml/sosw-shared-dynamodb.yaml
.. _the tutorial: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/GettingStarted.Walkthrough.html
.. _SignUp: https://portal.aws.amazon.com/billing/signup#/start

Building the docs
------------------

To build the docs locally, run `sphinx-build -ab html ./docs ./sosw-rtd`
then you can use the built in python web server `python -m http.server`
to view the html version directly from localhost in your preferred browser.
| To build the docs locally, run: ``sphinx-build -ab html ./docs ./sosw-rtd``
| Then you can use the built in python web server: ``python -m http.server`` to view the html version
directly from localhost in your preferred browser.

0 comments on commit bda0edb

Please sign in to comment.