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

Use magiclink extension for changelog with links #1278

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Use magiclink extension for changelog with links #1278

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
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# Force rtfd to use a recent version of mkdocs
mkdocs==1.4.2
pymdown-extensions==10.1
Copy link
Member

Choose a reason for hiding this comment

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

I think this can be put in pyproject.toml actually now, as RTFD is now using a modern version of mkdocs, and is it now, it is not installed when doing a make develop ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Historically, Read the Docs has installed MkDocs 0.17.3 by default if the project didn't define a specific version of it. Now, this version is a pretty old and we recommend our users to use the latest version of MkDocs: 1.5.1.

To avoid failing builds we kept the old default version of MkDocs. We are changing that behavior to always install the latest available version and we wanted to let you know about that so you can prepare your project.

Starting on October 3rd Read the Docs will install the latest available version of MkDocs. If you want to use a different version, make sure you are pinning your MkDocs dependency.

Email received on August, 2nd so it's not already deployed on their side?

Copy link
Member

Choose a reason for hiding this comment

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

Ah, right, it will be in october, my bad!

22 changes: 12 additions & 10 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
site_name: uMap
nav:
- Home: index.md
- Installation: install.md
- Configuration: settings.md
- Administration: administration.md
- Contributing: contributing.md
- how-tos:
- Ubuntu from scratch: ubuntu.md
- Customize your uMap style: custom.md
- Install with Docker: docker.md
- Changelog: changelog.md
- Home: index.md
- Installation: install.md
- Configuration: settings.md
- Administration: administration.md
- Contributing: contributing.md
- how-tos:
- Ubuntu from scratch: ubuntu.md
- Customize your uMap style: custom.md
- Install with Docker: docker.md
- Changelog: changelog.md
theme: readthedocs
markdown_extensions:
- pymdownx.magiclink