Skip to content

Commit

Permalink
fix git clone command in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
janash committed Apr 16, 2024
1 parent fde53f8 commit a9d01df
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions _episodes/10-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Objectives:
This episode discusses documentation strategies.
In particular, we will focus on how to build documentation using Sphinx and host that documentation online using [Read The Docs].


:::{admonition} Follow Along with This Lesson
:class: tip

Expand All @@ -26,20 +27,21 @@ point.
You will need to make sure that you have `git` installed and configured,
as described in the set-up instructions.

- [Download the pre-made workshop repository as a zip file](https://github.com/MolSSI-Education/molecool/archive/refs/tags/package-docs-start.zip)

Alternatively, download the repository using the command line:

````{tab-set-code}
```{code-block} shell
git clone https://github.com/MolSSI-Education/molecool.git
cd molecool
git checkout package-docs-start
git switch -c main
```
````
You can also [download the pre-made workshop repository as a zip file](https://github.com/MolSSI-Education/molecool/archive/refs/tags/git-start.zip).
If downloading as a zip file, you will need to initialize `git` in the repository and make an initial commit in order to use git.

:::


Documentation must be provided to allow for use, development, and maintenance of software.
Documentation is often overlooked by developers since it can be tedious and boring.
However, writing good documentation is an extremely good habit to develop.
Expand Down

0 comments on commit a9d01df

Please sign in to comment.