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

Add Jupyter integration to the docs #5403

Merged
merged 2 commits into from
Jun 28, 2023
Merged

Add Jupyter integration to the docs #5403

merged 2 commits into from
Jun 28, 2023

Conversation

dhruvmanila
Copy link
Member

Summary

Add Jupyter integration to the docs, specifically the Configuration and FAQ sections.

Test Plan

mkdocs serve and check that the new sections are visible and functional.

fixes: #5396

@dhruvmanila
Copy link
Member Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@github-actions
Copy link
Contributor

PR Check Results

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      8.2±0.03ms     4.9 MB/sec    1.00      8.2±0.02ms     4.9 MB/sec
formatter/numpy/ctypeslib.py               1.00   1710.8±3.38µs     9.7 MB/sec    1.00   1708.2±2.62µs     9.7 MB/sec
formatter/numpy/globals.py                 1.00    187.7±0.24µs    15.7 MB/sec    1.00    187.8±0.24µs    15.7 MB/sec
formatter/pydantic/types.py                1.01      3.9±0.01ms     6.6 MB/sec    1.00      3.8±0.01ms     6.6 MB/sec
linter/all-rules/large/dataset.py          1.00     13.6±0.04ms     3.0 MB/sec    1.00     13.7±0.05ms     3.0 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.4±0.01ms     4.8 MB/sec    1.00      3.5±0.01ms     4.8 MB/sec
linter/all-rules/numpy/globals.py          1.00    362.2±1.13µs     8.1 MB/sec    1.05   379.6±14.87µs     7.8 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.0±0.01ms     4.2 MB/sec    1.00      6.1±0.01ms     4.2 MB/sec
linter/default-rules/large/dataset.py      1.00      7.0±0.01ms     5.8 MB/sec    1.00      7.1±0.01ms     5.8 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1462.5±2.28µs    11.4 MB/sec    1.01  1474.9±11.09µs    11.3 MB/sec
linter/default-rules/numpy/globals.py      1.00    155.6±0.21µs    19.0 MB/sec    1.00    156.1±0.24µs    18.9 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.2±0.01ms     8.0 MB/sec    1.00      3.2±0.01ms     8.0 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      9.6±0.21ms     4.2 MB/sec    1.01      9.7±0.26ms     4.2 MB/sec
formatter/numpy/ctypeslib.py               1.01      2.0±0.10ms     8.2 MB/sec    1.00      2.0±0.07ms     8.3 MB/sec
formatter/numpy/globals.py                 1.00    227.2±9.65µs    13.0 MB/sec    1.03   232.9±15.69µs    12.7 MB/sec
formatter/pydantic/types.py                1.03      4.5±0.19ms     5.6 MB/sec    1.00      4.4±0.06ms     5.8 MB/sec
linter/all-rules/large/dataset.py          1.00     16.2±0.33ms     2.5 MB/sec    1.01     16.4±0.37ms     2.5 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.02      4.3±0.10ms     3.9 MB/sec    1.00      4.2±0.13ms     3.9 MB/sec
linter/all-rules/numpy/globals.py          1.01   504.6±17.35µs     5.8 MB/sec    1.00   498.2±17.66µs     5.9 MB/sec
linter/all-rules/pydantic/types.py         1.03      7.3±0.20ms     3.5 MB/sec    1.00      7.0±0.15ms     3.6 MB/sec
linter/default-rules/large/dataset.py      1.02      8.3±0.16ms     4.9 MB/sec    1.00      8.1±0.15ms     5.0 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1748.5±54.07µs     9.5 MB/sec    1.00  1749.4±55.08µs     9.5 MB/sec
linter/default-rules/numpy/globals.py      1.02   200.5±10.09µs    14.7 MB/sec    1.00    196.6±5.72µs    15.0 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.7±0.07ms     6.9 MB/sec    1.00      3.7±0.07ms     7.0 MB/sec

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jun 28, 2023
@charliermarsh charliermarsh enabled auto-merge (squash) June 28, 2023 00:18
@charliermarsh
Copy link
Member

Looks great, thanks!

@charliermarsh charliermarsh merged commit d19324d into main Jun 28, 2023
@charliermarsh charliermarsh deleted the dhruv/jupyter-docs branch June 28, 2023 00:27
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.

Add Jupyter integration to the docs
2 participants