Docs: remove blank rio options docs#3348
Conversation
|
@adamjstewart thanks for looking into this. We do want docs for the module, so it's worth adding a doc for it. |
|
Should this command work? > rio options
Usage: rio [OPTIONS] COMMAND [ARGS]...
Try 'rio --help' for help.
Error: No such command 'options'. |
|
Ah, seems like these are simply common/shared flags. |
adamjstewart
changed the title
|
Current implementation doesn't work: This file has no click function, so the docs would look completely different. It's still not clear to me what should be documented and how to document it. |
|
Okay, it's working now, although I'm not sure if I like how it's formatted. |
|
@sgillies what do you think of the current docs? |
|
@adamjstewart the only thing I would ask is that the
|
|
Running out of ideas to get this working... |
|
@adamjstewart Thanks for giving it a try! It's okay with me if you don't want to continue. I think Rasterio's API docs section need to be paved over to get a fresh start. I didn't really know what I was doing with sphinx-apidoc when I started, and it's improved since then. Also, the combination of the project wanting to use sphinx-click for the CLI documentation and something else for |
|
My personal vote would be to remove the |
adamjstewart
changed the title
|
Went back to the original PR implementation to solve the Sphinx warning. |
|
Thank @adamjstewart 👍 |
* Docs: remove rio options documentation * Add rio options docs * Simpler documentation structure * Try to add header * Change maxdepth * Change maxdepth * Change maxdepth * Back to original PR
3 participants
I don't fully understand whether or not
rio optionsis supposed to work, but there is no rst document for it, resulting in the following warning in RtD CI: