Visitar URL original
remove RST api docs references - replace with links to API docs by deruyter92 · Pull Request #3442 · DeepLabCut/DeepLabCut · GitHub
Skip to content

remove RST api docs references - replace with links to API docs - #3442

Merged
deruyter92 merged 4 commits into
jaap/prepare_tf_deprecationfrom
jaap/remove-rst-files
Aug 20, 2026
Merged

deruyter92 merged 4 commits into
jaap/prepare_tf_deprecationfrom
jaap/remove-rst-files

Conversation

@deruyter92

@deruyter92 deruyter92 commented Aug 12, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

After moving to mkdocs API docs, some old sphinx references and RST files were still in place. This PR removes the redudant RST files, and replaces the old API references with links to the API-docs.

Edit:
Also some dead links were updated in the main docs: apparently some pages and notebooks still referenced the old separate multi-animal and single-animal guides. These dead links are are now replaced with the correct link to the main user guide.

@C-Achard C-Achard left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching those, apologies for not converting them last time.

Should we delete:

  • docs/maDLC_UserGuide.md
  • docs/standardDeepLabCut_UserGuide.md

I think we fully reworked and replaced them in main-workflows, right?

@C-Achard C-Achard added the documentation documentation updates/comments label Aug 13, 2026
@C-Achard C-Achard added this to the v3.0.2 milestone Aug 13, 2026
@deruyter92
deruyter92 marked this pull request as ready for review August 19, 2026 09:20
@deruyter92
deruyter92 merged commit 2de70e2 into jaap/prepare_tf_deprecation Aug 20, 2026
3 checks passed
@deruyter92
deruyter92 deleted the jaap/remove-rst-files branch August 20, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation updates/comments

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants