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.

Sign up for GitHub

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

Jump to bottom

Fix Philosophy links, update copyright year, #4283

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix Philosophy links, update copyright year, #4283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs_nnx/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
# -- Project information -----------------------------------------------------

project = 'Flax'
copyright = '2023, The Flax authors' # pylint: disable=redefined-builtin
copyright = '2024, The Flax authors' # pylint: disable=redefined-builtin
author = 'The Flax authors'


Expand Down Expand Up @@ -113,7 +113,7 @@
# href with no underline and white bold text color
announcement = """
<a
href="https://flax-linen.readthedocs.io/en/latest"
href="https://flax.readthedocs.io/en/latest"
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to link to flax-linen here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Got it @cgarciae

Local builds seem fine even before the changes in this PR. ReadTheDocs' builds have the strange redirect for Glossary. As @IvyZX suggested maybe it's the redirect in the RTD config.

As discussed, will also rename the file to nnx_glossary.rst and see if that makes a difference.

style="text-decoration: none; color: white;"
>
This site covers the new Flax NNX API. <span style="color: lightgray;">[Click here for the old <b>Flax Linen</b> API]</span>
Expand Down Expand Up @@ -151,6 +151,7 @@
'guides/why.ipynb', # TODO(cgarciae): broken, remove in favor on the new guide
'guides/flax_gspmd.ipynb', # TODO(IvyZX): broken, needs to be updated
'guides/surgery.ipynb', # TODO(IvyZX): broken, needs to be updated
'guides/checkpointing.ipynb',
]
# raise exceptions on execution so CI can catch errors
nb_execution_allow_errors = False
Expand Down
4 changes: 2 additions & 2 deletions docs_nnx/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Features

.. div:: sd-font-normal

Flax NNX allows fine-grained control of the model's state via
Flax NNX enables fine-grained control of the model's state via
its `Filter <https://flax.readthedocs.io/en/latest/nnx/filters_guide.html>`__
system.

Expand Down Expand Up @@ -197,6 +197,6 @@ Learn more
guides/index
examples/index
glossary
The Flax philosophy <philosophyhttps://flax.readthedocs.io/en/latest/philosophy.html>
The Flax philosophy <https://flax.readthedocs.io/en/latest/philosophy.html>
How to contribute <https://flax.readthedocs.io/en/latest/contributing.html>
api_reference/index
Loading