Skip to content

add 2.0 documentation and make it the stable version - #24

Merged
melissawm merged 1 commit into
numpy:mainfrom
mattip:v2.0.0
Jun 17, 2024
Merged

melissawm merged 1 commit into
numpy:mainfrom
mattip:v2.0.0

Conversation

@mattip

@mattip mattip commented Jun 16, 2024

Copy link
Copy Markdown
Member

I followed the instructions in the Makefile, except for the force push.

@mattip

mattip commented Jun 16, 2024

Copy link
Copy Markdown
Member Author

cc @charris

@mattip

mattip commented Jun 16, 2024

Copy link
Copy Markdown
Member Author

Beyond adding the 2.0 files, I also

  • edited the index.html
  • added the version to version.json
  • used the python update.py script to update the old version warning, which I do not see anymore even on the existing documentation (???)
  • changed the stable symbolic link to point to 2.0

@melissawm

Copy link
Copy Markdown
Member

The version warning should be provided by the pydata sphinx theme now - so we should add

html_theme_options = {
    ...
    "show_version_warning_banner": True,
}

to conf.py (see https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/announcements.html#version-warning-banners - this page will actually show the functionality at the top)

@mattip

mattip commented Jun 17, 2024 •

Copy link
Copy Markdown
Member Author

The version warning should be provided by the pydata sphinx theme now

Can we do that in a follow on? I think this should be merged soon

Edit: make the responseinto a question

@melissawm

Copy link
Copy Markdown
Member

The stable docs will have to be rebuilt for that. If that's not an issue I'm happy to do It in a follow up 👍

@mattip

mattip commented Jun 17, 2024

Copy link
Copy Markdown
Member Author

I don't think rebuilding is an issue. More of a problem is getting the warning into the 1.26 and earlier docs.

@charris

charris commented Jun 17, 2024

Copy link
Copy Markdown
Member

Lets just get this in.

@charris charris closed this Jun 17, 2024
@charris charris reopened this Jun 17, 2024
@melissawm

Copy link
Copy Markdown
Member

I just submitted a PR to fix the version switcher as well: #25

I'll send another to turn on the version warning banner for the newer versions of the docs.

@charris

charris commented Jun 17, 2024

Copy link
Copy Markdown
Member

@melissawm Is there any reason not to merge this? If not, hit the merge button.

@melissawm

Copy link
Copy Markdown
Member

Please merge, we can fix the warning banner later. Just make sure to also merge the version switcher json update over at #25

@charris

charris commented Jun 17, 2024 •

Copy link
Copy Markdown
Member

Melissa, I want you to merge. You will feel better after :)

EDIT: Do you have commit rights?

@melissawm

Copy link
Copy Markdown
Member

I do, thanks @charris - let's do it, if I break it, it won't be the first time 😄

@melissawm
melissawm merged commit adf380b into numpy:main Jun 17, 2024
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.

3 participants