Skip to content

Commit

Permalink
Merge pull request #315 from akcano/main
Browse files Browse the repository at this point in the history
drop redundant link to init.sh
  • Loading branch information
akcano authored Dec 9, 2024
2 parents 47f5d3e + 3ab7597 commit 2866c4d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/content/enable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Run the initialisation script

The initialisation script will download all required files, update them, and copy them to the selected location.

1. Download :file:`init.sh` from the starter pack repository: :literalref:`https://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/use-canonical-sphinx-extension/init.sh`
1. Download :file:`init.sh` from the starter pack repository.
#. Put the script into the root folder of the Git repository in which you want to enable the starter pack.

This can be a new, empty repository or your code repository.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following steps will guide you through setting up your documentation using t

For more detailed information, see the other sections of the starter pack documentation.

1. Download the :literalref:`init.sh<https://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/use-canonical-sphinx-extension/init.sh>` file from the starter pack repository and place it into the directory where you want to set up your documentation.
1. Download the :file:`init.sh` file from the starter pack repository and place it into the directory where you want to set up your documentation.

#. Run the script and specify where you want the files for the documentation framework to be placed (either in the current directory or in a sub-directory).
Your own documentation files will need to be placed in the same directory (or sub-directories of it) later.
Expand Down

0 comments on commit 2866c4d

Please sign in to comment.