Skip to content

Commit

Permalink
updating link to badge and theme
Browse files Browse the repository at this point in the history
  • Loading branch information
thekaveman committed Oct 21, 2018
1 parent 4fc7dd7 commit 8858c5d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ name = "pypi"
sphinx = "*"
recommonmark = "*"
requests = "*"
sphinx-rtd-theme = "*"

[requires]
python_version = "3.6"
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
# mds-provider
# mds-provider [![Documentation Status][docs-status]][docs]

Tools for working with [MDS `provider`][provider] data.

Developed and tested with Python 3.7+.
Developed and tested with Python 3.6.

See [`mds-provider-services`](https://github.com/CityofSantaMonica/mds-provider-services) for real-world usage of many of these tools.

|docs| [Documentation](https://mds-provider.readthedocs.io/en/init-docs/).

## Installation

Install with `pip`:

```bash
$ pip install -e git+https://github.com/CityofSantaMonica/mds-provider@master#egg=mds_provider
```console
pip install -e git+https://github.com/CityofSantaMonica/mds-provider@master#egg=mds_provider
```

Or with `python` directly:

```
$ git clone https://github.com/CityofSantaMonica/mds-provider.git
$ cd mds-provider
$ python setup.py install
```console
git clone https://github.com/CityofSantaMonica/mds-provider.git
cd mds-provider
python setup.py install
```

## Package organization
Expand All @@ -36,7 +34,8 @@ $ python setup.py install
| [`providers`](mds/providers.py) | Work with the official [MDS Providers registry][registry] |
| [`schema`](mds/schema/) | Work with the official [MDS Provider JSON schemas][schemas] |


[docs]: https://mds-provider.readthedocs.io/en/latest/
[docs-status]: https://readthedocs.org/projects/mds-provider/badge/?version=latest
[provider]: https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master/provider
[registry]: https://github.com/CityofLosAngeles/mobility-data-specification/blob/master/providers.csv
[schemas]: https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master/generate_schema
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = []

source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
Expand Down Expand Up @@ -86,7 +86,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down

0 comments on commit 8858c5d

Please sign in to comment.