Skip to content

Update Sphinx Stack project setup link in README #603

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.

Sign up for GitHub

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

Merged
jahn-junior merged 2 commits into from
May 21, 2026
Merged

Update Sphinx Stack project setup link in README #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b87ccd
Update Sphinx Stack project setup link in README
nhennigan May 11, 2026
675cfed
Update CHANGELOG
nhennigan May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Upcoming

* Update link to documenation in README
* Add an `AUTOBUILD_EXTRA_OPTS` variable to extend sphinx-autobuild options for `make run`
* Add default support for the sphinx-llm extension
* Pin dependencies to major versions
Expand All @@ -12,6 +13,7 @@

### Changed

* `README.md` [#603](https://github.com/canonical/sphinx-stack/pull/603)
* `docs/conf.py` [#562](https://github.com/canonical/sphinx-docs-starter-pack/pull/562), [#576](https://github.com/canonical/sphinx-docs-starter-pack/pull/576), [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590), [#595](https://github.com/canonical/sphinx-docs-starter-pack/pull/595), [#598](https://github.com/canonical/sphinx-docs-starter-pack/pull/598)
* `docs/Makefile` [#575](https://github.com/canonical/sphinx-docs-starter-pack/pull/575), [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590)
* `docs/requirements.txt` [#590]([#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590))
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ documentation, and serve it to http://127.0.0.1:8000.

To learn more about how to install and configure the Sphinx Stack for your own project,
see the [Set up a new
project](https://canonical-sphinx-stack.readthedocs-hosted.com/stable/tutorial/set-up/)
project](https://canonical-sphinx-stack.readthedocs-hosted.com/latest/set-up-a-new-project/)
guide in the official documentation.

## Requirements and limitations
Expand Down
Loading