Skip to content

Commit 3888102

Browse files
authored
Update README about submodule
1 parent 59e1faf commit 3888102

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Repository for the sources and published documentation set, versioned for each S
1515
+ `src/functions-reference` - Stan Functions Reference
1616
+ `src/reference-manual` - Stan Reference Manual
1717
+ `src/stan-users-guide` - Stan Users Guide
18+
+ `src/quarto-config` - A submodule of the [stan-dev/quarto-config](https://github.com/stan-dev/quarto-config) repository for shared files between the docs and Stan website
1819

1920
* `docs`: the directory `docs` on branch `master` is the [publishing source](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) for the project pages site. Whenever a verified member of the Stan organization pushes to `docs` on branch `master`,
2021
GitHub (re)builds and (re)deploys the website.
@@ -34,15 +35,19 @@ the repository [quarto-config](https://github.com/stan-dev/quarto-config).
3435

3536
## Scripts to build and maintain the docset
3637

37-
### Check out submodule `quarto-config` into the `src` subdirectory
38+
**Checking out the repository**
3839

39-
To build the docs locally, you must first clone the quarto-config repo into the `src` subdirectory.
40+
In order to ensure the `quarto-config` folder is present, when cloning the repository, use the `--recursive` flag
4041

41-
```sh
42-
cd src
43-
git clone https://github.com/stan-dev/quarto-config
42+
```shell
43+
git clone --recursive https://github.com/stan-dev/docs.git
4444
```
4545

46+
If you already have a clone without this submodule, or if it falls out of date, you can run
47+
```shell
48+
git submodule update --init --recursive
49+
```
50+
To initialize or refresh it.
4651

4752
**`build.py`**
4853

0 commit comments

Comments
 (0)