Skip to content

Commit

Permalink
[tue-documentation] update git submodule command (#417)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthijsBurgh authored Feb 13, 2024
1 parent 10302aa commit 31dea52
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion tue-documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Or copy the value of `$TUE_DOCS_PATH` into the urlbar.
Python documentation is generated by [Sphinx](http://sphinx-doc.org/). A fully dynamic Sphinx configuration is available: [config](https://github.com/tue-robotics/tue_documentation_python.git). Add this to your package as a submodule,

```bash
git submodule add https://github.com/tue-robotics/tue_documentation_python.git FOLDER -b master
git submodule add -b master https://github.com/tue-robotics/tue_documentation_python.git FOLDER
```

Use `docs` or `docs/python` for `FOLDER`. Preferably `docs` is used in packages with only Python and `docs/python` if also other programming languages are used.
Expand Down

0 comments on commit 31dea52

Please sign in to comment.