RTD organization - Githubissues

astrodbtoolkit / astrodb_utils

https://astrodb-scripts.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

0 stars 3 forks source link

RTD organization #41

Open arjunsavel opened 4 months ago

arjunsavel commented 4 months ago

I have some questions about how we want to organize the readthedocs. A few classic pages are:

Installation
Getting started — this is what I have the most questions about, I guess. What does a "quickstart" look like for this project? Maybe #31 goes here?
API (auto-generated docstrings, etc.)

We could also have:

developer information (#11 could go here)
FAQ

What do y'all think?

kelle commented 4 months ago

Let's start off with Installation and Getting Started - this can be one page.

And the API docs.

As we start to fill these things in, I think it will be easier to figure out how to organize all the different types of docs we need.

kelle commented 4 months ago

But yes, I do think this should be the home for the docs relevant to the template repo and the while toolkit. (Since the template repo is a template, no docs should live there.)

I think these docs should be titled "AstroDB Toolkit".

arjunsavel commented 3 months ago

dev vs user documentation.

average user is not going to run the tests.

ADS token should be put with using the ingest_publication function.

arjunsavel commented 3 months ago

add to dev: linting situation.

pyproject toml has list of dependencies...dependencies for testing...this is a valid testing dependency. add ruff.

arjunsavel commented 2 months ago

Include discussion of longtable vs. widetable.