Skip to content

Commit

Permalink
Issue #140: Refactor release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark2000 committed Jun 12, 2024
1 parent bd631c3 commit 568caeb
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 53 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: pandoc/actions/setup@main
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
Expand All @@ -25,7 +26,7 @@ jobs:
cp docs/sitecustomize.py $(python -c 'import site; print(site.getsitepackages()[0])')/sitecustomize.py
- name: Install dependencies
run: |
pip install -e '.[docs]'
pip install -e '.[docs,rllib]'
# skip finish install steps
- name: Sphinx build
run: |
Expand Down
44 changes: 0 additions & 44 deletions .github/workflows/documentation_refactor.yml

This file was deleted.

8 changes: 1 addition & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ BSK-RL: Environments for Spacecraft Planning and Scheduling
GitHub <https://github.com/AVSLab/bsk_rl/>


.. warning::

Docs are currently being build from the ``refactor/v1_0_0``. This branch will be
merged into ``develop`` imminently, at which point this warning will go away.


.. warning::

The 1.0.0 release has significant changes from previous versions. See the
Expand All @@ -31,7 +25,7 @@ Python package for constructing `Gymnasium <https://gymnasium.farama.org/index.h
environments for spacecraft tasking problems. It is built on top of
`Basilisk <https://hanspeterschaub.info/basilisk>`_, a modular and fast spacecraft
simulation framework, making the simulation environments high-fidelity and computationally
efficient. BSK-RL also includes a collection of agents, training scripts, and examples
efficient. BSK-RL also includes a collection of utilities and examples
for working with these environments.

Quickstart
Expand Down
2 changes: 1 addition & 1 deletion docs/source/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Release Notes

Version 1.0.0
-------------
*Release Date: MMM. DD, YYYY*
*Release Date: Jun. 12, 2024*

First major release of BSK-RL.

Expand Down

0 comments on commit 568caeb

Please sign in to comment.