Skip to content

Commit

Permalink
[#232]: fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
g.trantham committed Jul 31, 2023
1 parent 26983e9 commit 89773ae
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
# NLDI Crawler
# NLDI Crawler (python)

This is a **work in progress**

This is to be a python port of the [nldi crawler](https://github.com/internetofwater/nldi-crawler).
It is used to ingest data from various sources and link it to the network if it is not already.
The only requirement is that the source system is able to provide GeoJSON via a web request
with the necessary attributes.

See the documentation [here](https://gzt5142.github.io/nldi-crawler-py/) for details of function, including design and usage.

Adding new pipeline


-----
[LICENSE](./docs/LICENSE.md) | [CONTRIBUTING](./docs/CONTRIBUTING.md) | [CODE of CONDUCT](./docs/CODE_OF_CONDUCT.md)
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Configuration for SPHINX document generator
"""
project = "NLDI Crawler"

author = "USGS"

copyright = f"2023, {author}"
extensions= [
"sphinx.ext.autodoc",
Expand All @@ -12,4 +14,5 @@
"sphinx_rtd_theme",
'sphinxcontrib.mermaid'
]

html_theme = "sphinx_rtd_theme"

0 comments on commit 89773ae

Please sign in to comment.