Skip to content

Commit 7f2d773

Browse files
committed
Issue #4: Vizard documentation.
1 parent cee6dfc commit 7f2d773

File tree

6 files changed

+446
-110
lines changed

6 files changed

+446
-110
lines changed

docs/build/doctrees/nbsphinx/examples/aeos.ipynb

+211-103
Large diffs are not rendered by default.

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"sphinx_rtd_theme",
4242
"nbsphinx",
4343
"sphinx.ext.mathjax",
44+
"sphinxcontrib.youtube",
4445
]
4546

4647
templates_path = ["_templates"]
@@ -234,7 +235,6 @@ def generate_index(self, index_path, file_paths, dir_paths, source_dir):
234235
f.write(lines)
235236

236237
def generate_autodoc(self, doc_path, source_file):
237-
238238
# Make header
239239
short_name = source_file.name.replace(".py", "")
240240
lines = ""

docs/source/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ for working with these environments.
3131
A whitepaper on the design philosophy behind BSK-RL and an example use case can be
3232
:download:`downloaded here <_static/stephenson_bskrl_2024.pdf>`.
3333

34+
.. youtube:: 8qR-AGrCFQw
35+
3436
Quickstart
3537
----------
3638
Installation

docs/source/release_notes.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Development Version
2626
* Improve performance of :class:`~bsk_rl.obs.Eclipse` observations by about 95%.
2727
* Logs a warning if the initial battery charge or buffer level is incompatible with its capacity.
2828
* Optimize communication when all satellites are communicating with each other.
29-
29+
* Enable Vizard visualization of the environment by setting the ``vizard_dir`` and ``vizard_settings``
30+
options in the environment.
3031

3132

3233
Version 1.0.1

0 commit comments

Comments
 (0)