Docs: pems_data architecture and usage
#196
Conversation
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
I opened this PR for review because I thought it would generate the docs preview... maybe it has to target the |
thekaveman
force-pushed
the
feat/pems-data-caching
branch
from
333392d to
826539e
Compare
thekaveman
force-pushed
the
docs/pems-data
branch
5 times, most recently
from
e9788dd to
98ae5e7
Compare
thekaveman
force-pushed
the
docs/pems-data
branch
4 times, most recently
from
6db8da9 to
de39ca1
Compare
thekaveman
force-pushed
the
feat/pems-data-caching
branch
2 times, most recently
from
ba373c0 to
1f4d38e
Compare
thekaveman
force-pushed
the
docs/pems-data
branch
from
de39ca1 to
91c8d8c
Compare
for generating docs from python docstrings
thekaveman
force-pushed
the
docs/pems-data
branch
from
91c8d8c to
eb583fa
Compare
because now mkdocs needs to read metadata from pems_data
|
Preview url: https://pems-196--compiler-previews.netlify.app |
notice during mkdocs build:
Material emoji logic has been officially moved into mkdocs-material
version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
instead of 'materialx.emoji.twemoji' in your 'mkdocs.yml' file.
```
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
```
'mkdocs_material_extensions' is deprecated and will no longer be
supported moving forward. This is the last release.
There was a problem hiding this comment.
These docs are really helpful and they look nice!
Just something I noticed, the Caching layer section has a top level mod (module) section header, but the other sections don't, they go directly to the class level. We could, for example, change data-sources.md to what is shown in the comment to have a mod top level, but it's not a big deal, just thought about mentioning it.
|
|
||
| The data source components are responsible for the actual reading of data (the "how"). The design uses an abstract interface, `IDataSource`, to define a standard contract for any data source, making it easy to swap and compose implementations. | ||
|
|
||
| ::: pems_data.sources.IDataSource |
There was a problem hiding this comment.
We could also go to the top module level:
::: pems_data.sources
::: pems_data.sources.s3
::: pems_data.sources.cache
There was a problem hiding this comment.
Maybe we can come back to this? I agree it would make more sense to link to the module level if e.g. there were more classes / helper functions etc. in those modules.
Closes #197
pems_datapackage.mkdocstringsandmkdocstrings-pythonto autogenerate docs from Python docstrings.PREVIEW: https://pems-196--compiler-previews.netlify.app/development/pems_data/