Skip to content

Update README.md #1

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

Merged
alanmansour merged 1 commit into from
Nov 5, 2025
Merged

Update README.md #1

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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ All documentation, on the other hand, is stored in `docs/`. Documentation is a c
If you haven't done so already, check:
- [Docs](/docs/) and learn how our project documentation is structured in `rst` and `md` files.
- [Lib](/lib/) and learn how to work with packages.
- [Docs Webpage](https://dalsa-lab.github.io/cpp_python_project_template/)
- [Docs Webpage](https://dalsa-lab.github.io/cpp_python_project_template/).

Do you think that's not enough? If not, then checking the following is highly recommended:
- [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) (explore **reStructuredText Primer**, **Roles**, and **Directives**).
- [Sphinx Extensions](https://www.sphinx-doc.org/en/master/usage/extensions/index.html).
- [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html).
- [Doxygen Documenting Code Guide](https://www.doxygen.nl/manual/docblocks.html).
- Check [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/index.html) and [Clang-Format](https://clang.llvm.org/docs/ClangFormat.html).
- Check [Ruff](https://docs.astral.sh/ruff/).
- [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) (explore **reStructuredText Primer**, **Roles**, and **Directives**)
- [Sphinx Extensions](https://www.sphinx-doc.org/en/master/usage/extensions/index.html)
- [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
- [Doxygen Documenting Code Guide](https://www.doxygen.nl/manual/docblocks.html)
- [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/index.html) and [Clang-Format](https://clang.llvm.org/docs/ClangFormat.html)
- [Ruff](https://docs.astral.sh/ruff/)

## To Produce Documentation Locally:
Assuming you are in the root directory of this project and have a Python envioment to work with:
Expand Down