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

New Sphinx Setup for Director #83

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Aug 14, 2024

Note

The current state is very much incomplete - it's mostly here so if anyone wants to help out, they can,
and others can see the progress.

Improve the documentation of director, and convert to using Sphinx for documentation.
You can build it locally with

cd docs
pip install -r rtd-requirements.txt
make html  # or make.bat html for Windows

Ideally, this PR should have no production changes.

TODO

  • Port old guides to sphinx
  • Rewrite architecture guide
  • Write detailed guide about each part of director
  • Create/Upload Director logo

Follow-Ups

  • Port Director documentation to Sphinx
  • Get autodocumentation of manager, orchestrator, and other subprojects working.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant