Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Documentation site #146

Draft
wants to merge 140 commits into
base: dev
Choose a base branch
from
Draft

Documentation site #146

wants to merge 140 commits into from

Conversation

tsampazk
Copy link
Member

@tsampazk tsampazk commented Jun 3, 2023

Here's a list of changes for this PR:

  • Added the /docs/ directory as well as .readthedocs.yaml so that https://readthedocs.org/ can generate a documentation site for the framework
  • Large parts of the main README have been modified, mainly removing the "how it works" section. This section has been moved into the documentation site and overhauled (/docs/how_deepbots_works.rst)
  • Added some [project] info into pyproject.toml

Right now the readthedocs documentation site targets the fork. When this PR is merged, it will be switched to target the main repo.

Things TODO:

  • Add some text into the intermediate indexing pages like deepbots.supervisor.rst?
  • Add some text into the pages that contain the classes for some high level explanations?
  • Go through all docstrings and improve
  • Add docstings to methods that don't have one
  • Investigate into moving the tutorials in the documentation site, or duplicate them there somehow?
  • Same for deepworlds?

@tsampazk tsampazk added the documentation Improvements or additions to documentation label Jun 3, 2023
@tsampazk tsampazk self-assigned this Jun 3, 2023
@tsampazk tsampazk linked an issue Jun 3, 2023 that may be closed by this pull request
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation site
1 participant