diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8e19e31..4057fa9 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -64,7 +64,7 @@ Changelog Hey, the stable is here! -* Completed documentation: http://storyboard.rtfd.org +* Completed documentation: https://storyboard.readthedocs.io * Added ``--include-sha1sum`` option to console script ``storyboard`` (useful when SHA-1 digest is disabled from config file) * Fixed frame extraction when video duration is missing or wrong in diff --git a/README.md b/README.md index 364daa1..c64df8b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/zmwangx/storyboard?branch=master&svg=true)](https://ci.appveyor.com/project/zmwangx/storyboard) [![Coverage Status](https://coveralls.io/repos/github/zmwangx/storyboard/badge.svg?branch=master)](https://coveralls.io/github/zmwangx/storyboard?branch=master) -*Main documentation on Read the Docs:* http://storyboard.rtfd.org +*Main documentation on Read the Docs:* https://storyboard.readthedocs.io *Caution: Development has been deferred indefinitely as of July 23, 2015. However, contributions are welcome, and the maintainer will @@ -28,13 +28,13 @@ Note that this README only provides an overview and summary of the topics listed ## Background -*Main article:* http://storyboard.rtfd.org/en/latest/index.html +*Main article:* https://storyboard.readthedocs.io/en/latest/index.html `storyboard` was inspired by the storyboards I frequently encounter on video-sharing Internet forums, mostly generated by proprietary video players. Those storyboards often come with video/file metadata bundled, which I see as a great all-in-one solution for video sharing, saving one the labor of typing multiple console commands, copying and pasting output, and worrying about the forum's crappy formatting. However, I, for one, dislike proprietary players. Also, those storyboards are usually ugly and uninformative, using stupid fonts and lacking crucial information that hackers look for (e.g., hash). Therefore, I developed this customizable storyboard generator for hackers. ## Installation and dependencies -*Main article:* http://storyboard.rtfd.org/en/latest/install.html +*Main article:* https://storyboard.readthedocs.io/en/latest/install.html ### Dependencies @@ -54,18 +54,18 @@ Developers should clone the git repo for docs, tests, and more. ## Command-line usage -*Main article:* http://storyboard.rtfd.org/en/latest/cli.html +*Main article:* https://storyboard.readthedocs.io/en/latest/cli.html This package installs two console scripts, `metadata` and `storyboard`. You may find documentation of both using the `-h,--help` option. Extensive documentation is also available for both: -* `metadata` CLI reference: [metadata-cli.html](http://storyboard.rtfd.org/en/latest/metadata-cli.html); -* `storyboard` CLI reference: [storyboard-cli.html](http://storyboard.rtfd.org/en/latest/storyboard-cli.html). +* `metadata` CLI reference: [metadata-cli.html](https://storyboard.readthedocs.io/en/latest/metadata-cli.html); +* `storyboard` CLI reference: [storyboard-cli.html](https://storyboard.readthedocs.io/en/latest/storyboard-cli.html). By the way, the default invocation is really simple (for both): just supply one or more video paths. ## Sample storyboards -*Main article:* http://storyboard.rtfd.org/en/latest/sample.html +*Main article:* https://storyboard.readthedocs.io/en/latest/sample.html [![](https://i.imgur.com/OIx20KQ.jpg)](https://i.imgur.com/gtBArx7.jpg) @@ -73,7 +73,7 @@ By the way, the default invocation is really simple (for both): just supply one ## Issues -*Main article:* http://storyboard.rtfd.org/en/latest/issue.html +*Main article:* https://storyboard.readthedocs.io/en/latest/issue.html ### Reporting diff --git a/README.rst b/README.rst index ef50c67..38412ce 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ |Latest Version| |Supported Python versions| |License| |Docs| |Build Status| |Windows Build Status| |Coverage Status| -*Main documentation on Read the Docs:* http://storyboard.rtfd.org +*Main documentation on Read the Docs:* https://storyboard.readthedocs.io *Caution: Development has been deferred indefinitely as of July* *23, 2015. However, contributions are welcome, and the maintainer will* @@ -35,7 +35,7 @@ Structure of this document Background ---------- -*Main article:* http://storyboard.rtfd.org/en/latest/index.html +*Main article:* https://storyboard.readthedocs.io/en/latest/index.html ``storyboard`` was inspired by the storyboards I frequently encounter on video-sharing Internet forums, mostly generated by proprietary video @@ -51,7 +51,7 @@ this customizable storyboard generator for hackers. Installation and dependencies ----------------------------- -*Main article:* http://storyboard.rtfd.org/en/latest/install.html +*Main article:* https://storyboard.readthedocs.io/en/latest/install.html Dependencies ~~~~~~~~~~~~ @@ -84,7 +84,7 @@ Developers should clone the git repo for docs, tests, and more. Command-line usage ------------------ -*Main article:* http://storyboard.rtfd.org/en/latest/cli.html +*Main article:* https://storyboard.readthedocs.io/en/latest/cli.html This package installs two console scripts, ``metadata`` and ``storyboard``. You may find documentation of both using the @@ -92,9 +92,9 @@ This package installs two console scripts, ``metadata`` and both: - ``metadata`` CLI reference: - `metadata-cli.html `__; + `metadata-cli.html `__; - ``storyboard`` CLI reference: - `storyboard-cli.html `__. + `storyboard-cli.html `__. By the way, the default invocation is really simple (for both): just supply one or more video paths. @@ -102,7 +102,7 @@ supply one or more video paths. Sample storyboards ------------------ -*Main article:* http://storyboard.rtfd.org/en/latest/sample.html +*Main article:* https://storyboard.readthedocs.io/en/latest/sample.html |image10| @@ -111,7 +111,7 @@ Sample storyboards Issues ------ -*Main article:* http://storyboard.rtfd.org/en/latest/issue.html +*Main article:* https://storyboard.readthedocs.io/en/latest/issue.html Reporting ~~~~~~~~~ @@ -230,7 +230,7 @@ Changelog Hey, the stable is here! -* Completed documentation: http://storyboard.rtfd.org +* Completed documentation: https://storyboard.readthedocs.io * Added ``--include-sha1sum`` option to console script ``storyboard`` (useful when SHA-1 digest is disabled from config file) * Fixed frame extraction when video duration is missing or wrong in diff --git a/src/storyboard/metadata.py b/src/storyboard/metadata.py index e8be764..48ba714 100755 --- a/src/storyboard/metadata.py +++ b/src/storyboard/metadata.py @@ -1234,8 +1234,8 @@ def main(): in https://docs.python.org/3/library/configparser.html). For more detailed explanations, see - http://storyboard.rtfd.org/en/stable/metadata-cli.html (or replace - "stable" with the version you are using). + https://storyboard.readthedocs.io/en/stable/metadata-cli.html (or + replace "stable" with the version you are using). """ parser = argparse.ArgumentParser(description=description) parser.add_argument( diff --git a/src/storyboard/storyboard.py b/src/storyboard/storyboard.py index 3fac6b0..4f8809b 100755 --- a/src/storyboard/storyboard.py +++ b/src/storyboard/storyboard.py @@ -1068,8 +1068,8 @@ def main(): wrapper script around the storyboard.storyboard if you'd like to. For more detailed explanations, see - http://storyboard.rtfd.org/en/stable/storyboard-cli.html (or replace - "stable" with the version you are using). + https://storyboard.readthedocs.io/en/stable/storyboard-cli.html (or + replace "stable" with the version you are using). """ parser = argparse.ArgumentParser(description=description) parser.add_argument(