Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start writing docs. #24

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

mkcor
Copy link
Member

@mkcor mkcor commented Dec 3, 2024

Hi @lagru,

Here I'm starting some minimal documentation as per #9.

I'm using the same structure and formats as scikit-image's so we can use the same machinery to build the docs, i.e., generated the rendered HTML pages. I guess we should deploy these somewhere?

I've noticed that

Maybe it would be more consistent to have doc/src/index.rst instead of doc/source/index.rst?

@lagru lagru mentioned this pull request Dec 4, 2024
21 tasks
@lagru lagru added the documentation Improvements or additions to documentation label Dec 4, 2024
@lagru
Copy link
Member

lagru commented Dec 4, 2024

Thanks for getting this going @mkcor!

I've been thinking about how to keep the effort for the documentation infrastructure low during early development. E.g. start with a Wiki on the Repo? I'm also considering to go "full markdown" for docstubs documentation via MyST?

I'm curious what you think.

Maybe it would be more consistent to have doc/src/index.rst instead of doc/source/index.rst?

I've never really been a fan of the extra doc/source/ folder / level in scikit-image and would love to avoid it here if we can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants