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: combine Cython, C, and pybind11 parts #44

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

henryiii
Copy link
Contributor

I noticed this now has some duplicated information, and someone looking for pybind11 or C API information shouldn't have to read paragraphs about Cython directives. I've build this locally to make sure the nested tabs work.

@@ -39,7 +39,7 @@ jobs:
run: pip install -r requirements.txt

- name: Build site
run: mkdocs build
run: mkdocs build --strict
Copy link
Contributor Author

@henryiii henryiii Jul 18, 2024

Choose a reason for hiding this comment

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

I also added this. Example of why this must be passed for all mkdocs builds: https://cibuildwheel.pypa.io/en/v2.18.0/options/

Yes, the default is to render the error into the page and report the build passing...

Copy link
Member

Choose a reason for hiding this comment

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

oh wow, that is .... not good

@rgommers rgommers added the documentation Improvements or additions to documentation label Jul 18, 2024
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Good catch, thanks Henry!

@rgommers rgommers merged commit ba94ff3 into Quansight-Labs:main Jul 18, 2024
1 check passed
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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants