Skip to content

Commit

Permalink
Merge pull request #32 from ColCarroll:main
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 611162661
  • Loading branch information
The bayeux Authors committed Feb 28, 2024
2 parents 131b685 + fc0b6ba commit 92a2bfb
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 23 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ jobs:
- name: Upload docs
run: |
mkdocs build # twice, see https://github.com/patrick-kidger/pytkdocs_tweaks
mkdocs gh-deploy --force
mkdocs build
mkdocs gh-deploy --force
11 changes: 0 additions & 11 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,21 +63,10 @@ plugins:
- mkdocstrings:
handlers:
python:
setup_commands:
- import pytkdocs_tweaks
- pytkdocs_tweaks.main()
- import jaxtyping
- jaxtyping.set_array_name_format("array")
- import jax
- jax.ShapeDtypeStruct.__module__ = "jax"
- import typing
- typing.Any.__module__ = "builtins"

selection:
inherited_members: true # Allow looking up inherited methods
rendering:
show_root_heading: true # actually display anything at all...
show_root_full_path: true # display "bayeux.asdf" not just "asdf"
show_if_no_docstring: true
show_signature_annotations: true
show_source: false # don't include source code
Expand Down
15 changes: 5 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,11 @@ dev = [

docs = [
# Latest versions at time of writing.
"mkdocs==1.3.0", # Main documentation generator.
"mkdocs-material==7.3.6", # Theme
"pymdown-extensions==9.4", # Markdown extensions e.g. to handle LaTeX.
"mkdocstrings==0.17.0", # Autogenerate documentation from docstrings.
"mknotebooks==0.7.1", # Turn Jupyter Lab notebooks into webpages.
"pytkdocs_tweaks==0.0.8", # Tweaks mkdocstrings to improve various aspects
"jinja2==3.0.3", # Older version. After 3.1.0 seems to be incompatible with current versions of mkdocstrings.
"nbconvert==6.5.0", # | Older verson to avoid error
"nbformat==5.4.0", # |
"pygments==2.14.0"
"mkdocs==1.5.3", # Main documentation generator.
"mkdocs-material==9.5.11", # Theme
"pymdown-extensions==10.7", # Markdown extensions e.g. to handle LaTeX.
"mkdocstrings==0.24.1", # Autogenerate documentation from docstrings.
"mknotebooks==0.8.0", # Turn Jupyter Lab notebooks into webpages.
]

[tool.pyink]
Expand Down

0 comments on commit 92a2bfb

Please sign in to comment.