diff --git a/README.md b/README.md index 6a801ef..3625aac 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,16 @@ -# Sphinx Stack +# Sphinx Stack testing -[](https://github.com/canonical/sphinx-stack/actions/workflows/test-sphinx-stack.yml) +An internal repository for various testing/QA experiments and benchmarks for [Sphinx Stack](https://github.com/canonical/sphinx-stack) functionality. Unrelated to the [standard documentation build tests](https://github.com/canonical/sphinx-stack/blob/main/.github/workflows/test-sphinx-stack.yml). -A standard set of tools for building and publishing Sphinx documentation. +This is kept in a separate repo to not interfere with the default Sphinx Stack template, and because I'm not exactly sure what all of this even is yet but I needed somewhere to put it. -The Sphinx Stack contains a set of CLI commands and a default set of extensions, -configuration options, and tests. +## Repository structure -## Basic usage +The **`main`** branch is a copy of the Sphinx Stack with the addition of a general canary page that renders example structures of all (relevant) default extensions of the Sphinx Stack. It's a work in progress, and currently relies on visual verification. -To try out the Sphinx Stack, clone it locally and navigate to the `/docs` directory: - -```shell -git clone git@github.com:canonical/sphinx-stack.git -cd docs -``` - -Then, run the command - -```shell -make run -``` - -This will create a Python virtual environment, install necessary dependencies, build the -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/latest/set-up-a-new-project/) -guide in the official documentation. - -## Requirements and limitations - -The Sphinx Stack is designed for projects hosted on GitHub. This is necessary to run the -automatic checks in .github/workflows, and to publish your documentation on Read the -Docs. - -If you have a project that is hosted on a different versioning platform, like Launchpad, -[reach out to us](#reach-out). - -## Community and support - -The Sphinx Stack is an open-source project that warmly welcomes community involvement. - -If you’re new to the community, make sure to read through the [Ubuntu Code of -Conduct](https://ubuntu.com/community/code-of-conduct) first. - -### Reach out - -* Report an issue or make a suggestion via - [GitHub](https://github.com/canonical/sphinx-stack/issues) -* Come chat with the Canonical Documentation team in our [public Matrix - channel](https://matrix.to/#/#documentation:ubuntu.com) - -### Contribute - -The Sphinx Stack provides a shared foundation for Sphinx documentation projects, and -contributions help improve the documentation of all its users. - -* See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on contributing to - development or documentation. -* Check [open issues](https://github.com/canonical/sphinx-stack/issues) +Branches with the prefix **`scenario/`** will be simulations of documentation projects with different types of complexity. These don't exist yet, but plans include scenarios like: +* `scenario/custom-html-css` +* `scenario/custom-ci` +* `scenario/custom-requirements` +* `scenario/java` +* `scenario/custom-build` diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html index e1d1088..ffd301d 100644 --- a/docs/_templates/footer.html +++ b/docs/_templates/footer.html @@ -80,7 +80,7 @@ {%- endif %}