search

akaihola / darker

Apply black reformatting to Python files only in regions changed since a given commit. For a practical usage example, see the blog post at https://dev.to/akaihola/improving-python-code-incrementally-3f7a
https://pypi.org/project/darker/
Other
638 stars 55 forks source link

create base for readthedocs sphinx site #764

Closed clintonsteiner closed 2 weeks ago

clintonsteiner commented 1 month ago

Generate with

sphinx-build -b html ./source ./build

or

make html
clintonsteiner commented 1 month ago

Linking https://github.com/akaihola/darker/issues/78

clintonsteiner commented 3 weeks ago

https://github.com/akaihola/darker/pull/766 Think this is probably a better approach, thoughts?

akaihola commented 2 weeks ago

766 Think this is probably a better approach, thoughts?

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?

clintonsteiner commented 2 weeks ago

766 Think this is probably a better approach, thoughts?

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