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

Doc build #166

Merged
merged 25 commits into from
Jan 27, 2025
Merged

Doc build #166

merged 25 commits into from
Jan 27, 2025

Conversation

jay-m-dev
Copy link
Contributor

What does this PR do?

  • Refactor documentation workflow and deploy process to include the docs from tpot1 (legacy docs).
  • Add logo and deprecation warning to legacy docs.
  • Update the primary color on the legacy docs.
  • Add a warning that the legacy version of tpot is no longer maintained.
  • Update all instances of 'tpot2' to 'tpot' throughout documentation.
  • Update all instances of 'tpot2' to 'tpot' in the source code.

Where should the reviewer start?

Ensure all tests are passing and that the documentation website is deployed correctly. When deployed it will contain the 'latest' and 'archived' versions of the doc website.

How should this PR be tested?

  • All automated tests should pass.
  • Tutorials should run successfully.
  • Local tests should be performed to ensure there are no issues with package renaming.

Any background context you want to provide?

The source code (tutorials and tests) should be checked before merging. Some parts of the documentation may contain broken links (because of the tpot2 to tpot renaming.) But these visual elements will be fixed after migrating all source code to the original tpot repo.

Questions:

Do the docs need to be updated?

  • All docs have been revised and updated in this PR.
    Does this PR add new (Python) dependencies?
  • No.

@jay-m-dev jay-m-dev merged commit d93576c into main Jan 27, 2025
2 checks passed
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.

2 participants