Skip to content

docs: update HowToLens references after extraction to standalone repo#468

Merged
Jammy2211 merged 1 commit intomainfrom
feature/howtolens-docs-update
Apr 21, 2026
Merged

docs: update HowToLens references after extraction to standalone repo#468
Jammy2211 merged 1 commit intomainfrom
feature/howtolens-docs-update

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

HowToLens has been extracted from autolens_workspace into its own repository at PyAutoLabs/HowToLens. This PR updates all PyAutoLens documentation, the README, and the JOSS paper to point at the new standalone repo.

  • Migrates every HowToLens Colab URL from the old autolens_workspace/notebooks/howtolens/... path to the new PyAutoLabs/HowToLens/blob/2026.4.13.6/notebooks/... path (version tag matches the workspace version at extraction).
  • Rewrites prose in README.rst, docs/index.rst, docs/general/workspace.rst, docs/overview/overview_2_new_user_guide.rst, docs/howtolens/howtolens.rst, and paper/paper.md to frame HowToLens as a separate repo alongside the workspace rather than a sub-folder inside it.
  • Updates the per-chapter readthedocs pages (chapter_1_introduction.rst, chapter_2_lens_modeling.rst, chapter_3_search_chaining.rst, chapter_4_pixelizations.rst, chapter_optional.rst) so each tutorial's Colab badge resolves to the new repo.

Third of three PRs for the HowToLens extraction:

  1. PyAutoLabs/HowToLens — initial repo, tagged 2026.4.13.6
  2. PyAutoLabs/autolens_workspace#80 — remove the old notebooks/howtolens/ tree and fix internal references
  3. This PR — update PyAutoLens docs to point at the new repo

Test plan

  • readthedocs build succeeds on the branch preview
  • URL-check CI (if configured) confirms every HowToLens URL resolves
  • Spot-check one Colab link from each chapter loads the notebook from PyAutoLabs/HowToLens at tag 2026.4.13.6

Closes #467

🤖 Generated with Claude Code

HowToLens has been extracted from autolens_workspace into its own
repository at PyAutoLabs/HowToLens. Update all documentation and
paper references accordingly:

- Migrate Colab URLs from PyAutoLabs/autolens_workspace/.../notebooks/
  howtolens/ to PyAutoLabs/HowToLens/blob/2026.4.13.6/notebooks/ (tag
  matches the autolens_workspace version at extraction time).
- Rewrite README, index, paper, and overview prose to frame HowToLens
  as a standalone repo alongside the workspace, rather than a
  sub-folder within it.
- Update the HowToLens lecture-series pages (chapters 1-4 and the
  optional chapter) so each tutorial's Colab badge points at the new
  repo.

Closes #467

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.

docs: update HowToLens references after extraction to standalone repo

1 participant