Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[tue-documentation] update git submodule command #417

Merged
merged 1 commit into from
Feb 13, 2024
Merged

[tue-documentation] update git submodule command #417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tue-documentation/README.md
View file
Open in desktop
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