Skip to content

Commit

Permalink
fix: Update init.sh (#295)
Browse files Browse the repository at this point in the history
* fix: Update init.sh

* docs: Update README.rst

Update RTD URL

* docs: Update contributing.rst

Remove references to deprecated pages
  • Loading branch information
SecondSkoll authored Oct 10, 2024
1 parent 0a60e50 commit 1876225
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Documentation starter pack includes:
* Build checks for links, spelling, and inclusive language
* Customisation support layered over a core configuration

See the full documentation: https://canonical-starter-pack.readthedocs-hosted.com/use-canonical-sphinx-extension/
See the full documentation: https://canonical-starter-pack.readthedocs-hosted.com/

Structure
---------
Expand Down Expand Up @@ -45,4 +45,4 @@ This directory contains files used to test the functionality of the starter pack

.. LINKS
.. _`Sphinx`: https://www.sphinx-doc.org/
.. _`Sphinx`: https://www.sphinx-doc.org/
2 changes: 1 addition & 1 deletion init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ temp_directory="temp-starter-pack-$(date +%Y%m%d%H%M%S)"

# Clone the starter pack repository into the temporary directory and de-git it
echo "Cloning the starter pack repository..."
git clone --depth 1 -b extension-main-combined --single-branch https://github.com/canonical/starter-pack "$temp_directory"
git clone --depth 1 -b main --single-branch https://github.com/canonical/starter-pack "$temp_directory"
rm -rf "$temp_directory/.git"

# Update workflow and documentation files based on the installation directory
Expand Down
8 changes: 0 additions & 8 deletions sp-files/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -263,14 +263,6 @@ It is based on the `Canonical starter pack
<https://canonical-starter-pack.readthedocs-hosted.com/latest/>`_
and hosted on `Read the Docs <https://about.readthedocs.com/>`_.

For general guidance,
refer to the `starter pack guide
<https://canonical-starter-pack.readthedocs-hosted.com/latest/readme/>`_.

For syntax help and guidelines,
refer to the `Canonical style guides
<https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/#style-guides>`_.

In structuring,
the documentation employs the `Diátaxis <https://diataxis.fr/>`_ approach.

Expand Down

0 comments on commit 1876225

Please sign in to comment.