Merge pull request #209 from treyhunner/fix-typo

Fix a typo & remove docs
treyhunner · May 10, 2024 · bd308d8 · bd308d8
2 parents 1eba404 + 4387cff
commit bd308d8
Show file tree

Hide file tree

Showing 19 changed files with 8 additions and 102 deletions.
diff --git a/.cookiecutter.json b/.cookiecutter.json
diff --git a/.darglint b/.darglint
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,12 +23,12 @@ jobs:
 
       - name: Upgrade pip
         run: |
-          pip install --constraint=.github/workflows/constraints.txt pip
+          pip install pip
           pip --version
 
       - name: Install Poetry
         run: |
-          pip install --constraint=.github/workflows/constraints.txt poetry
+          pip install poetry
           poetry --version
 
       - name: Check if there is a parent commit

diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -8,13 +8,11 @@ welcomes contributions in the form of bug reports, feature requests, and pull re
 Here is a list of important resources for contributors:
 
 - `Source Code`_
-- `Documentation`_
 - `Issue Tracker`_
 - `Code of Conduct`_
 
 .. _MIT license: https://opensource.org/licenses/MIT
 .. _Source Code: https://github.com/treyhunner/countdown-cli
-.. _Documentation: https://countdown-cli.readthedocs.io/
 .. _Issue Tracker: https://github.com/treyhunner/countdown-cli/issues
 
 How to report a bug

diff --git a/README.rst b/README.rst
@@ -3,7 +3,7 @@ countdown-cli
 
 |PyPI| |Status| |Python Version| |License|
 
-|Read the Docs| |Tests| |Codecov|
+|Tests| |Codecov|
 
 |pre-commit| |Black|
 
@@ -19,9 +19,6 @@ countdown-cli
 .. |License| image:: https://img.shields.io/pypi/l/countdown-cli
    :target: https://opensource.org/licenses/MIT
    :alt: License
-.. |Read the Docs| image:: https://img.shields.io/readthedocs/countdown-cli/latest.svg?label=Read%20the%20Docs
-   :target: https://countdown-cli.readthedocs.io/
-   :alt: Read the documentation at https://countdown-cli.readthedocs.io/
 .. |Tests| image:: https://github.com/treyhunner/countdown-cli/workflows/Tests/badge.svg
    :target: https://github.com/treyhunner/countdown-cli/actions?workflow=Tests
    :alt: Tests
@@ -40,7 +37,7 @@ If you're working on that exercise right now, please **don't look at the source
 
 |Logo|
 
-.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/python-morsels-logo.png
+.. |Logo| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/python-morsels-logo.png
    :target: https://www.pythonmorsels.com
    :width: 400
    :alt: an adorable snake taking a bite out of a cookie with the words Python Morsels next to it (Python Morsels logo)
@@ -60,11 +57,11 @@ Features
 
 |14:57|
 
-.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/3253.png
+.. |32:53| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/3253.png
    :width: 500
    :alt: 32:53 shown in large letters in center of an xterm window (black background with white text)
 
-.. |14:57| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/docs/images/1457.png
+.. |14:57| image:: https://raw.githubusercontent.com/treyhunner/countdown-cli/main/images/1457.png
    :width: 500
    :alt: 14:57 shown in large letters in center of terminal window (light background with darker text)
 
@@ -85,12 +82,6 @@ You can install *countdown-cli* via pip_ from PyPI_:
    $ python3 -m pip install countdown-cli
 
 
-Usage
------
-
-Please see the `Command-line Reference <Usage_>`_ for details.
-
-
 Contributing
 ------------
 
@@ -127,4 +118,3 @@ This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter
 .. _pip: https://pip.pypa.io/
 .. github-only
 .. _Contributor Guide: CONTRIBUTING.rst
-.. _Usage: https://countdown-cli.readthedocs.io/en/latest/usage.html
diff --git a/docs/codeofconduct.rst b/docs/codeofconduct.rst
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/license.rst b/docs/license.rst
diff --git a/docs/reference.rst b/docs/reference.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/usage.rst b/docs/usage.rst
diff --git a/docs/images/1457.png → images/1457.png b/docs/images/1457.png → images/1457.png
diff --git a/docs/images/3253.png → images/3253.png b/docs/images/3253.png → images/3253.png
diff --git a/docs/images/python-morsels-logo.png → images/python-morsels-logo.png b/docs/images/python-morsels-logo.png → images/python-morsels-logo.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,12 @@
 [tool.poetry]
 name = "countdown-cli"
-version = "1.0.2"
+version = "1.0.3"
 description = "Terminal program to display countdown timer"
 authors = ["Trey Hunner <[email protected]>"]
 license = "MIT"
 readme = "README.rst"
 homepage = "https://github.com/treyhunner/countdown-cli"
 repository = "https://github.com/treyhunner/countdown-cli"
-documentation = "https://countdown-cli.readthedocs.io"
 packages = [
     { include = "countdown", from = "src" },
 ]

diff --git a/src/countdown/__main__.py b/src/countdown/__main__.py
@@ -66,7 +66,7 @@ def main(duration):
 
     \b
     - 5m (5 minutes)
-    - 45s (30 seconds)
+    - 45s (45 seconds)
     - 2m30s (2 minutes and 30 seconds)
     """  # noqa: D301
     enable_ansi_escape_codes()