Mishaal
65355c5d29
Remove PRIVATE PROTECTED and STATIC access overrides ( #3821 )
...
* Remove PRIVATE PROTECTED and STATIC access overrides
* Bump up requirements version
---------
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2025-07-23 10:58:58 -07:00
M Starch
cca4e1261c
Remove RPI project in lieu of the LED workshop ( #3908 )
2025-07-22 15:31:22 -07:00
Ashley Nilo
548012bbf9
Auto-generate nav with mkdocs-awesome-nav ( #3460 )
...
* Awesome Nav Changes
* Awesome Nav Changes
* Bring up to date with latest
* This is AWESOME
* Rename files for ordering
* Remove How-To prefix in titles
* Fix spelling
* Remove old sdd_processing.py script
---------
Co-authored-by: thomas-bc <thomas.boyer.chammard@jpl.nasa.gov>
2025-04-25 14:15:20 -07:00
Thomas Boyer-Chammard
6f1369bbcf
Update docs structure for website versioning improvements ( #3150 )
...
---------
Co-authored-by: ashleynilo <ashley.k.santiago@jpl.nasa.gov>
2025-01-21 14:32:52 -08:00
Thomas Boyer-Chammard
334c525984
Add SDD aggregation into the core website ( #3139 )
2025-01-15 14:05:46 -08:00
Josh Soref
5be3b19881
Check spelling 0.0.24 ( #3051 )
...
* Change line endings
* link: Checklist
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: described in detail
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: F´ key features
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: `Fw::Buffer` documentation is available
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: installing cmake command line tools on a mac
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: Svc.StaticMemory is described in more detail
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: testing_fw/predicates.py
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* link: the source code
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: a
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: adhered
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: cannot
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: case-sensitive
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: deployment
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: filter events based on event severity
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: its
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: nonexistent
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: prepending
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: products
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: schema
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: stressful
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: the
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: valued
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* Add check-spelling
---------
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2024-12-17 10:02:50 -08:00
Ashley Nilo
9367a3ba2f
Restructure docs for new website ( #3036 )
...
---------
Co-authored-by: chammard <thomas.boyer.chammard@jpl.nasa.gov>
2024-12-06 12:48:09 -08:00
Thomas Boyer-Chammard
0fe467c6e2
Add -Wno-format-truncation to root project ( #2719 )
...
* Remove BUILD_TYPE=Release
* Add -Wno-format-truncation
* Only push to docs branch if from devel branch
* Only when not clang
* lock gcc version
* Lock to GCC and remove extra stuff
* debugging
* more debugging...
* Revert changes to autodocs CI
* Don't use -Wno-format-truncation when using clang-tidy
2024-05-20 17:08:16 -07:00
M Starch
3166546c76
Fixing Documentation Generation fo macOS ( #2655 )
...
* Adding minor fixes to gen docs script for mac
* Adding in HowTo to docs generation
* sp
2024-04-02 17:39:31 -07:00
Thomas Boyer-Chammard
ec1a9b9f3e
Update Doxygen config ( #2370 )
...
* Fix Doxygen pages
* Fix Doxygen configuration
* Add Design documentation to versioned folder
* Update doxygen usage
* Add googletest folder to doxygen ignore
* Update doxygen mainpage
* Exclude mainpage.md from spellcheck (repeated words)
* Add back subindex
2023-11-27 12:11:34 -08:00
Thomas Boyer-Chammard
1e8d4131ad
Improve linkage of CMake documentation ( #2355 )
2023-11-09 11:48:07 -08:00
Josh Soref
9633049549
Upgrade to check-spelling v0.0.22 ( #2316 )
...
* drop: @params None
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: anymore
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: baremetal
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: cannot
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: cookiecutter
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: macos
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: neither
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: nonexistent
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: param
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: unix
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* grammar: like
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* Update check-spelling to v0.0.22
- enables sarif reporting
- enables checking dependabot PRs to validate extra_dictionaries in the
future
- refreshes dictionaries
- refreshes metadata
* Shim for check-spelling v0.0.21
* Comment out false positive
---------
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2023-10-26 13:32:48 -07:00
Josh Soref
f3e4f1e3b2
Update check-spelling to v0.0.20 ( #1583 )
...
* spelling: and
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: command
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: cycle
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: dependent
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: github
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: nonexistent
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: pass
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: preexisting
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: that
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* spelling: the
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* Update check-spelling
2022-08-22 14:31:36 -07:00
Carlos Domani
4daf59b1db
Fix broken Doxygen image references ( #1425 )
2022-04-28 17:25:43 -07:00
Carlos Domani
b85a34b3f7
Fix mainpage pages and move references into respective subpages ( #1423 )
2022-04-28 17:25:20 -07:00
Sadra Yahyapour
edc2f1c4d3
Using TAB escape sequence instead of pure spaces ( #1353 )
...
* using \t instead if raw spaces
* isort observed
* black observed
2022-04-12 12:38:49 -07:00
M Starch
af37cc476c
lestarch: update to doxygen file
2021-12-13 15:00:31 -08:00
M Starch
eebef10711
lestarch: updating .hpp and .md files for clean doxygen run ( #676 )
2021-06-07 21:10:09 -07:00
Joshua Anderson
c8d00eab5b
Update doxygen documentation generation script
2021-06-03 14:40:19 -07:00
Josh Soref
1be591b202
spelling: varying the
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-07 14:49:51 -05:00
Josh Soref
68f22e5b42
spelling: manageable
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-07 14:48:32 -05:00
Josh Soref
4faadb7406
spelling: filt
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-07 14:48:29 -05:00
Josh Soref
33732ac2f4
spelling: element
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-07 14:48:29 -05:00
Josh Soref
93eb9abe3f
spelling: conditional
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-03-07 14:48:28 -05:00
saba-ja
9a236de788
fixing generate_docs.bash to handle modern fprime-util
2021-02-11 18:37:49 -08:00
Michael D Starch
59ef49ef6f
mstarch: updating documentation generation to adjust for github
2020-11-14 13:34:11 -08:00
Michael D Starch
3300e68f16
mstarch: adding basic script for documentation generation
2020-10-14 11:45:56 -07:00
Michael D Starch
b9675055f4
mstarch: adding autogenerated doxygen documentation
2020-08-26 22:33:02 -07:00