Central API Docs #1041
Central API Docs #1041
Conversation
Documentation preview |
docs/source/toc.yaml
Outdated
| - file: api_overview | ||
| title: API Documentation |
There was a problem hiding this comment.
The docs become a little dense with this all under one TOC item. If you are open to experimenting, consider creating another caption like line 3 with "API Documentation" or "Merlin API" or something along those lines.
Centralizing the API is certainly better than how I left it, but I'm also wondering if adding titles would help the reader choose the correct API rather than browse.
There was a problem hiding this comment.
I feel the structure looks easy to follow - it is structured in the way how we would import Classes, functions or modules
merlin.dag
merlin.loader
merlin.io
merlin.models
merlin.schema
merlin.systems
nvtabular
There was a problem hiding this comment.
It might still be nice to organize the packages into themes or something though, because I suspect this makes the most sense to people who are already familiar with what's in each sub-package (e.g. people on the Merlin team.)
There was a problem hiding this comment.
@karlhigley do you have a suggestions? I thought organizing it by import statements is the way a user will search for API documentation?
If I want to know something about ColumnsSelector, I know it is in merlin.schema and I will look there first?
| allowlist_externals = | ||
| git | ||
| cp | ||
| commands = | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/core.git ./docs/core | ||
| cp -r ./docs/core/docs/source/api ./docs/source/api_core/ | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/dataloader.git ./docs/dataloader | ||
| cp ./docs/dataloader/docs/source/api.rst ./docs/source/api_dataloader.rst | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/models.git ./docs/models | ||
| cp ./docs/models/docs/source/api.rst ./docs/source/api_models.rst | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/NVTabular.git ./docs/NVTabular | ||
| cp ./docs/NVTabular/docs/source/api.rst ./docs/source/api_nvtabular.rst | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/systems.git ./docs/systems | ||
| cp ./docs/systems/docs/source/api.rst ./docs/source/api_systems.rst | ||
| git clone --depth 1 https://github.com/NVIDIA-Merlin/Transformers4Rec.git ./docs/Transformers4Rec | ||
| cp -r ./docs/Transformers4Rec/docs/source/api ./docs/source/api_transformers4rec/ | ||
| python -m sphinx.cmd.build -E -P -b html docs/source docs/build/html |
There was a problem hiding this comment.
If tox alone can get you what you need, I think I'd just go with that. (And, tbh, it escaped my imagination that tox would make it so simple.)
The only alternative that I'd consider is using one of the containers because the containers already have the tagged source in the container.
There was a problem hiding this comment.
I wasn't sure if the documentation is build inside a container - in addition, I want to pull the latest documentation code from every repository
No description provided.