Skip to content

Transition from readme to actually using sphinx docs - #245

Merged
Zac-HD merged 8 commits into
python-trio:mainfrom
jakkdl:use_docs
May 14, 2024
Merged

Zac-HD merged 8 commits into
python-trio:mainfrom
jakkdl:use_docs

Conversation

@jakkdl

@jakkdl jakkdl commented May 13, 2024

Copy link
Copy Markdown
Member
  • remove most stuff from README.md
  • add links to docs in pypi and readme
  • add badge for pypi and coverage to readme
  • add links to contributor guide and changelog to docs

I'll probably transition the contributor guide and changelog to sphinx as well

…e. Add badge for pypi and coverage to readme.
@jakkdl

jakkdl commented May 13, 2024 •

Copy link
Copy Markdown
Member Author

When reviewing contributing.rst I recommend viewing the diff for 40bfeee separately, as I made a bunch of changes after the direct translation.

also I ran out of free tokens as I let Claude translate the changelog, oops

@Zac-HD Zac-HD left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great 📖🚀

@Zac-HD
Zac-HD enabled auto-merge (squash) May 13, 2024 21:52
@Zac-HD

Zac-HD commented May 13, 2024

Copy link
Copy Markdown
Member

Oops, we now have a semantic merge conflict where the latest changelog entry has been dropped. Well, other than that it's ready to merge 😅

@jakkdl

jakkdl commented May 14, 2024

Copy link
Copy Markdown
Member Author

Meta tests did their job!

@Zac-HD
Zac-HD merged commit e788a35 into python-trio:main May 14, 2024
@jakkdl
jakkdl deleted the use_docs branch May 14, 2024 09:41
@jakkdl jakkdl mentioned this pull request May 17, 2024
4 of 5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants