diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mkdocs-redirects.spec | 351 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 353 insertions, 0 deletions
@@ -0,0 +1 @@ +/mkdocs-redirects-1.2.0.tar.gz diff --git a/python-mkdocs-redirects.spec b/python-mkdocs-redirects.spec new file mode 100644 index 0000000..18065f8 --- /dev/null +++ b/python-mkdocs-redirects.spec @@ -0,0 +1,351 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mkdocs-redirects +Version: 1.2.0 +Release: 1 +Summary: A MkDocs plugin for dynamic page redirects to prevent broken links. +License: MIT +URL: https://github.com/datarobot/mkdocs-redirects +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/48/7c/ee2b4f6d632c6b93bd6fc49aadfffea75904cf56cb27e0008a0a57a4fddf/mkdocs-redirects-1.2.0.tar.gz +BuildArch: noarch + + +%description +# mkdocs-redirects + +Plugin for [`mkdocs`](https://www.mkdocs.org/) to create page redirects (e.g. for moved/renamed pages). + +Initially developed by [DataRobot](https://www.datarobot.com/). + +## Installing + +> **Note:** This package requires MkDocs version 1.0.4 or higher. + +Install with pip: + +```bash +pip install mkdocs-redirects +``` + +## Using + +To use this plugin, specify your desired redirects in the plugin's `redirect_maps` setting in your `mkdocs.yml`: + +```yaml +plugins: + - redirects: + redirect_maps: + 'old.md': 'new.md' + 'old/file.md': 'new/file.md' + 'some_file.md': 'http://external.url.com/foobar' +``` + +_Note: don't forget that specifying the `plugins` setting will override the defaults if you didn't already have it set! See [this page](https://www.mkdocs.org/user-guide/configuration/#plugins) for more information._ + +The redirects map should take the form of a key/value pair: + +- The key of each redirect is the original _markdown doc_ (relative to the `docs_dir` path). + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the original markdown doc's filename was (or what it _would be_ if it existed), not the final HTML file rendered by MkDocs +- The value is the _redirect target_. This can take the following forms: + - Path of the _markdown doc_ you wish to be redirected to (relative to `docs_dir`) + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the markdown doc's filename is, not the final HTML file rendered by MkDocs + - External URL (e.g. `http://example.com`) + +During the `mkdocs build` process, this plugin will create `.html` files in `site_dir` for each of the "old" file that redirects to the "new" path. +It will produce a warning if any problems are encountered or of the redirect target doesn't actually exist (useful if you have `strict: true` set). + +### `use_directory_urls` + +If you have `use_directory_urls: true` set (which is the default), this plugin will modify the redirect targets to the _directory_ URL, not the _actual_ `index.html` filename. +However, it will create the `index.html` file for each target in the correct place so URL resolution works. + +For example, a redirect map of `'old/dir/README.md': 'new/dir/README.md'` will result in an HTML file created at `$site_dir/old/dir/index.html` which redirects to `../../new/dir/`. + +Additionally, a redirect map of `'old/dir/doc_name.md': 'new/dir/doc_name.md'` will result in `$site_dir/old/dir/doc_name/index.html` redirecting to `../../new/dir/doc_name/`. + +This mimics the behavior of how MkDocs builds the site dir without this plugin. + +## Developing + +### Setup a virtualenv + +Create a virtualenv using a method of your choice. + +```bash +brew install pyenv pyenv-virtualenv +pyenv install 2.7.18 +pyenv virtualenv 2.7.18 mkdocs-redirects +pyenv activate mkdocs-redirects +``` + +### Build + +```bash +make build +``` + +### Test + +```bash +make test +``` + +## Releasing + +```bash +make release +``` + +It will prompt you for your PyPI user and password. + +See: + +- <https://packaging.python.org/tutorials/packaging-projects/> +- <https://packaging.python.org/guides/migrating-to-pypi-org/> + + +%package -n python3-mkdocs-redirects +Summary: A MkDocs plugin for dynamic page redirects to prevent broken links. +Provides: python-mkdocs-redirects +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mkdocs-redirects +# mkdocs-redirects + +Plugin for [`mkdocs`](https://www.mkdocs.org/) to create page redirects (e.g. for moved/renamed pages). + +Initially developed by [DataRobot](https://www.datarobot.com/). + +## Installing + +> **Note:** This package requires MkDocs version 1.0.4 or higher. + +Install with pip: + +```bash +pip install mkdocs-redirects +``` + +## Using + +To use this plugin, specify your desired redirects in the plugin's `redirect_maps` setting in your `mkdocs.yml`: + +```yaml +plugins: + - redirects: + redirect_maps: + 'old.md': 'new.md' + 'old/file.md': 'new/file.md' + 'some_file.md': 'http://external.url.com/foobar' +``` + +_Note: don't forget that specifying the `plugins` setting will override the defaults if you didn't already have it set! See [this page](https://www.mkdocs.org/user-guide/configuration/#plugins) for more information._ + +The redirects map should take the form of a key/value pair: + +- The key of each redirect is the original _markdown doc_ (relative to the `docs_dir` path). + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the original markdown doc's filename was (or what it _would be_ if it existed), not the final HTML file rendered by MkDocs +- The value is the _redirect target_. This can take the following forms: + - Path of the _markdown doc_ you wish to be redirected to (relative to `docs_dir`) + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the markdown doc's filename is, not the final HTML file rendered by MkDocs + - External URL (e.g. `http://example.com`) + +During the `mkdocs build` process, this plugin will create `.html` files in `site_dir` for each of the "old" file that redirects to the "new" path. +It will produce a warning if any problems are encountered or of the redirect target doesn't actually exist (useful if you have `strict: true` set). + +### `use_directory_urls` + +If you have `use_directory_urls: true` set (which is the default), this plugin will modify the redirect targets to the _directory_ URL, not the _actual_ `index.html` filename. +However, it will create the `index.html` file for each target in the correct place so URL resolution works. + +For example, a redirect map of `'old/dir/README.md': 'new/dir/README.md'` will result in an HTML file created at `$site_dir/old/dir/index.html` which redirects to `../../new/dir/`. + +Additionally, a redirect map of `'old/dir/doc_name.md': 'new/dir/doc_name.md'` will result in `$site_dir/old/dir/doc_name/index.html` redirecting to `../../new/dir/doc_name/`. + +This mimics the behavior of how MkDocs builds the site dir without this plugin. + +## Developing + +### Setup a virtualenv + +Create a virtualenv using a method of your choice. + +```bash +brew install pyenv pyenv-virtualenv +pyenv install 2.7.18 +pyenv virtualenv 2.7.18 mkdocs-redirects +pyenv activate mkdocs-redirects +``` + +### Build + +```bash +make build +``` + +### Test + +```bash +make test +``` + +## Releasing + +```bash +make release +``` + +It will prompt you for your PyPI user and password. + +See: + +- <https://packaging.python.org/tutorials/packaging-projects/> +- <https://packaging.python.org/guides/migrating-to-pypi-org/> + + +%package help +Summary: Development documents and examples for mkdocs-redirects +Provides: python3-mkdocs-redirects-doc +%description help +# mkdocs-redirects + +Plugin for [`mkdocs`](https://www.mkdocs.org/) to create page redirects (e.g. for moved/renamed pages). + +Initially developed by [DataRobot](https://www.datarobot.com/). + +## Installing + +> **Note:** This package requires MkDocs version 1.0.4 or higher. + +Install with pip: + +```bash +pip install mkdocs-redirects +``` + +## Using + +To use this plugin, specify your desired redirects in the plugin's `redirect_maps` setting in your `mkdocs.yml`: + +```yaml +plugins: + - redirects: + redirect_maps: + 'old.md': 'new.md' + 'old/file.md': 'new/file.md' + 'some_file.md': 'http://external.url.com/foobar' +``` + +_Note: don't forget that specifying the `plugins` setting will override the defaults if you didn't already have it set! See [this page](https://www.mkdocs.org/user-guide/configuration/#plugins) for more information._ + +The redirects map should take the form of a key/value pair: + +- The key of each redirect is the original _markdown doc_ (relative to the `docs_dir` path). + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the original markdown doc's filename was (or what it _would be_ if it existed), not the final HTML file rendered by MkDocs +- The value is the _redirect target_. This can take the following forms: + - Path of the _markdown doc_ you wish to be redirected to (relative to `docs_dir`) + - This plugin will handle the filename resolution during the `mkdocs build` process. + This should be set to what the markdown doc's filename is, not the final HTML file rendered by MkDocs + - External URL (e.g. `http://example.com`) + +During the `mkdocs build` process, this plugin will create `.html` files in `site_dir` for each of the "old" file that redirects to the "new" path. +It will produce a warning if any problems are encountered or of the redirect target doesn't actually exist (useful if you have `strict: true` set). + +### `use_directory_urls` + +If you have `use_directory_urls: true` set (which is the default), this plugin will modify the redirect targets to the _directory_ URL, not the _actual_ `index.html` filename. +However, it will create the `index.html` file for each target in the correct place so URL resolution works. + +For example, a redirect map of `'old/dir/README.md': 'new/dir/README.md'` will result in an HTML file created at `$site_dir/old/dir/index.html` which redirects to `../../new/dir/`. + +Additionally, a redirect map of `'old/dir/doc_name.md': 'new/dir/doc_name.md'` will result in `$site_dir/old/dir/doc_name/index.html` redirecting to `../../new/dir/doc_name/`. + +This mimics the behavior of how MkDocs builds the site dir without this plugin. + +## Developing + +### Setup a virtualenv + +Create a virtualenv using a method of your choice. + +```bash +brew install pyenv pyenv-virtualenv +pyenv install 2.7.18 +pyenv virtualenv 2.7.18 mkdocs-redirects +pyenv activate mkdocs-redirects +``` + +### Build + +```bash +make build +``` + +### Test + +```bash +make test +``` + +## Releasing + +```bash +make release +``` + +It will prompt you for your PyPI user and password. + +See: + +- <https://packaging.python.org/tutorials/packaging-projects/> +- <https://packaging.python.org/guides/migrating-to-pypi-org/> + + +%prep +%autosetup -n mkdocs-redirects-1.2.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mkdocs-redirects -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.0-1 +- Package Spec generated @@ -0,0 +1 @@ +c3c08f17a3a604d1f47ba5ada4111147 mkdocs-redirects-1.2.0.tar.gz |