diff --git a/Pipfile b/Pipfile index 535add3..0734540 100644 --- a/Pipfile +++ b/Pipfile @@ -9,6 +9,7 @@ name = "pypi" sphinx = "*" recommonmark = "*" requests = "*" +sphinx-rtd-theme = "*" [requires] python_version = "3.6" diff --git a/README.md b/README.md index 377cf24..fc66a76 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index b926c53..c948838 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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', @@ -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