Moving current docs to Pydata [issue #1390]

[cassiasamp]

Addresses issue #1390

• Installs Sphinx PyData theme
• Enables light and dark mode
• Changes some configurations in conf.py

Verification

List the steps needed to make sure this thing works

• Supporting configuration such as generator configuration file

{
    "huggingface": {
        "torch_type": "float32"
    }
}

• garak -m <model_type> -n <model_name>
• Run the tests and ensure they pass python -m pytest tests/
• ...
• Verify the thing does what it should
• Verify the thing does not do what it should not
• Document the thing and how it works (Example)

If you are opening a PR for a new plugin that targets a specific piece of hardware or requires a complex or hard-to-find testing environment, we recommend that you send us as much detail as possible.

Specific Hardware Examples:

• GPU related
  • Specific support required cuda / mps ( Please not cuda via ROCm if related )
  • Minium GPU Memory

Complex Software Examples:

• Expensive proprietary software
• Software with an extensive installation process
• Software without an English language UI

[jmartin-tech]

HTML files should never be committed here. The .gitignore should explicitly exclude these.

[jmartin-tech]

This looks like a miss in the changes as using the prior make command these files would have been at docs/source/html which is properly excluded.

[cassiasamp]

Hi @jmartin-tech would it help if I make the changes for .gitignore in this PR or should I create an issue and submit another PR for that?

I've also mentioned that there was a bug in the _ext files when I started this change, it was an easy fix and I could also help with that.

[jmartin-tech]

The docs build should not place files outside the docs folder, please adjust any build process changes to ensure the path for artifacts stays docs/source/html which is already registered as excluded in .gitignore.

I suspect the build location difference was simply due to how you are invoking the build process. The docs/README.md notes usage of the command make -C docs/source doc when building from the root of the repo. If you used some other command please validate that documented pattern is still valid and does not leave generated files in locations not already accounted for.

As far as the _ext files question, no context on what was found has been provided, if added here please document what what the issue was why it needed to be addressed.

[cassiasamp]

thanks for clarifying. I have removed the wrongly placed html files and included the fixed garak_ext file.

to provide more context on the _ext file, the small bug was due to the use of double and single quotation marks in the fstring, line 28.

[jmartin-tech]

Great spot on the quotation syntax.

Please consider a rebase and squash to keep the files add and removes from living on in the git history.

Once this is promoted from draft a full review of the impacts will be done.

[jmartin-tech]

Remove if this is no-longer valid, however we definitely still want the css theme to be usable.

[cassiasamp]

will work on that, it broke when the theme changed

[cassiasamp]

Hi @jmartin-tech, commits have been squashed..I believe this is finally ready for review.
I tried to maintain the structure of the original docs to best of my ability.

ps: this may also fix issue #1405 quickly in the future