jpsider / RestPS

Simple ReST Framework for Powershell
MIT License
113 stars 30 forks source link

update read the docs based on email for MkDocs  #82

Open jpsider opened 1 year ago

jpsider commented 1 year ago
Hello, -- You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.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.Here you have a pretty simple example of the section required on the .readthedocs.yaml configuration file:python: install: - requirements: docs/requirements.txt The content of docs/requirements.txt would be similar to:mkdocs==1.5.1 We are sending you this email because you are a maintainer of the following projects that are affected by this removal:restpsRead more about this in our Reproducible builds guide for more details. Keep documenting,Read the Docs Hello, You are receving this email because your Read the Docs project is impacted by an upcoming deprecation. 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. Here you have a pretty simple example of the section required on the .readthedocs.yaml configuration file: python: install: - requirements: docs/requirements.txt The content of docs/requirements.txt would be similar to: mkdocs==1.5.1 We are sending you this email because you are a maintainer of the following projects that are affected by this removal: [restps](https://readthedocs.org/projects/restps/) Read more about this in our [Reproducible builds](https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html) guide for more details. Keep documenting, Read the Docs