twosixlabs / armory

ARMORY Adversarial Robustness Evaluation Test Bed
MIT License
174 stars 67 forks source link

Remove Read the Docs integration #1963

Closed christopherwoodall closed 1 year ago

christopherwoodall commented 1 year ago

We are planning to remove support for readthedocs and shift towards using plain markdown files for our documentation.

Reasoning:

Tasks to be Completed:

Timeline:

We aim to complete the transition NLT the end of the week. However, we understand that unforeseen challenges might arise, so we'll closely monitor the progress and adjust the timeline accordingly.

mwartell commented 1 year ago

I question the value of readthedocs now that Github markdown support has gotten so capable and Github pages can fill any gaps left. Fewer dependencies are better. Fewer sites that we need to talk to to make docs are better.

christopherwoodall commented 1 year ago

Paused until pyyaml issues[2] are resolved.

Edit: Retargeting branch objectives 🤖

christopherwoodall commented 1 year ago

See issue thread in tensorflow/models#11051

EDIT: Resolved image