Skip to content
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.

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

[BUG] - Documentation not rendering properly #18

Open
onaish-dstl opened this issue Feb 21, 2024 · 2 comments
Open

[BUG] - Documentation not rendering properly #18

onaish-dstl opened this issue Feb 21, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@onaish-dstl
Copy link

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:

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

Screenshots/Outputs

Initial View

image

Content after a lot of scrolling

image

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.

@onaish-dstl onaish-dstl added the bug Something isn't working label Feb 21, 2024
@jamesshort1
Copy link
Collaborator

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

@ChrisMcCarthyDev
Copy link
Contributor

ChrisMcCarthyDev commented Mar 1, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants