-
Notifications
You must be signed in to change notification settings - Fork 56
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
create base for readthedocs sphinx site #764
Conversation
…b html ./source ./build
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In setup.cfg
, we should probably add sphinx
to either darker[release]
extra dependencies, or to a new darker[docs]
extra.
Co-authored-by: Antti Kaihola <[email protected]>
#766 |
#766 is indeed way simpler and adds minimal changes. It's a better approach as long as we choose to stick with a single page of documentation. I'm trying to think of any benefits from full-fledged multi-page documentation with a more focused README. The change log and contribution guide could then of course be rendered as part of the documentation pages, and maybe more technical detail included as a separate page. What do you think about the trade-offs between the two approaches? |
I think choose the simple option until theres a reason to do the hard one |
Generate with
or