[BUG] - Documentation not rendering properly

onaish-dstl commented 7 months ago

Describe the bug:

The interactive elements in the PrimAITE v2.0.0 docs are not rendering correctly, making the docs really hard to navigate.

To Reproduce:

Go to https://autonomous-resilient-cyber-defence.github.io/PrimAITE/
Scroll through the confusion

Screenshots/Outputs

Initial View

Content after a lot of scrolling

Environment

Tried on both:

OS: Ubuntu
PrimAITE Version: v2.0.0
Software: FireFox

And:

OS: Windows
PrimAITE Version: v2.0.0
Software: Chrome

with same results.

Additional Note:

Useful to add the link to the docs in the about section of the GitHub Code page. Press the cog at the top right of the about section and tick the box about GitHub Pages links.

jamesshort1 commented 7 months ago

Hi @onaish-dstl Thank you for posting this issue. We are now looking into it, and will respond to you very soon

ChrisMcCarthyDev commented 7 months ago

Hi @onaish-dstl. Unfortunately there was an issue with the Docs build pipeline when we deployed for V2. We're aiming to fix this before the release of V3. As an interim measure, the docs can be built locally by cloning the repo, installing PrimAITE, and then calling make html.

Windows Powershell

git clone https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE.git
cd PrimAITE
pip install -e .[dev]
cd docs
.\make.bat html

Unix

git clone https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE.git
cd PrimAITE
pip install -e .[dev]
cd docs
make html

Autonomous-Resilient-Cyber-Defence / PrimAITE