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

docs: add sphinx / readthedocs configuration #121

Merged
merged 1 commit into from
Mar 7, 2021
Merged

Conversation

davidhewitt
Copy link
Member

This PR adds a first pass at sphinx documentation for the project. There's definitely more that could be added, however I think this makes a nice start before we release version 0.12 .

Rendered

@davidhewitt davidhewitt requested a review from messense March 7, 2021 12:35
Copy link
Member

@messense messense left a comment

Choose a reason for hiding this comment

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

Looks great!

@@ -129,70 +133,6 @@ You can then upload the `manylinux2014` wheels to pypi using [twine](https://git

It is possible to use any of the `manylinux` docker images: `manylinux1`, `manylinux2010` or `manylinux2014`. (Just replace `manylinux2014` in the above instructions with the alternative version you wish to use.)

Copy link
Member

Choose a reason for hiding this comment

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

I think we should add a section about how to build macOS universal2 binary wheels here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed, I'll add it later today in a follow-up PR 👍

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