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

create base for readthedocs sphinx site #764

Closed
wants to merge 2 commits into from

Conversation

clintonsteiner
Copy link
Collaborator

@clintonsteiner clintonsteiner commented Oct 22, 2024

Generate with

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

or

make html

@clintonsteiner clintonsteiner marked this pull request as draft October 22, 2024 00:58
@clintonsteiner
Copy link
Collaborator Author

Makefile Show resolved Hide resolved
source/conf.py Outdated Show resolved Hide resolved
Copy link
Owner

@akaihola akaihola left a 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.

source/index.rst Show resolved Hide resolved
@akaihola akaihola changed the title create base for readthedocs sphinx site, generate with sphinx-build -… create base for readthedocs sphinx site Oct 23, 2024
@akaihola akaihola added the documentation Improvements or additions to documentation label Oct 23, 2024
@akaihola akaihola added this to the Darker 3.1.0 milestone Oct 23, 2024
Co-authored-by: Antti Kaihola <[email protected]>
@clintonsteiner
Copy link
Collaborator Author

#766
Think this is probably a better approach, thoughts?

@akaihola
Copy link
Owner

akaihola commented Nov 7, 2024

#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
Copy link
Collaborator Author

#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

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
Development

Successfully merging this pull request may close these issues.

2 participants