Skip to content

README sphinx website generation#766

Closed
clintonsteiner wants to merge 4 commits intoakaihola:masterfrom
clintonsteiner:docsGenEasy
Closed

README sphinx website generation#766
clintonsteiner wants to merge 4 commits intoakaihola:masterfrom
clintonsteiner:docsGenEasy

Conversation

@clintonsteiner
Copy link
Copy Markdown
Collaborator

@clintonsteiner clintonsteiner commented Oct 31, 2024

  • Made significantly easier and still used sphinx

Notes:

@akaihola akaihola assigned akaihola and clintonsteiner and unassigned akaihola Nov 7, 2024
@akaihola akaihola added the documentation Improvements or additions to documentation label Nov 7, 2024
@akaihola akaihola added this to the Darker 3.1.0 milestone Nov 7, 2024
Comment thread .github/actions/SphinxBuild.yml Outdated
Comment thread .github/actions/SphinxBuild.yml Outdated
Comment thread .github/workflows/sphinx-build.yml Outdated
on:
push:
branches:
- master
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we try this once in this branch just to see that it works, and then revert back to - master before merging?

Comment thread .github/workflows/sphinx-build.yml Outdated
path: ./sphinx_output/

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be sure, so this is going to publish the documentation at https://akaihola.github.io/darker?

@clintonsteiner
Copy link
Copy Markdown
Collaborator Author

https://github.com/clintonsteiner/darker-docs

Created outside repo here demonstrating usage

Copy link
Copy Markdown
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.

Looking at https://clintonsteiner.github.io/darker-docs/ it seems limiting the TOC to top level only would be an improvement. Now the detailed TOC fills the top screenful of the documentation page.

@clintonsteiner clintonsteiner closed this by deleting the head repository Apr 28, 2026
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