Skip to content

Update and rename README.rst to README.md #387

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
a-velasco merged 2 commits into from
May 29, 2025
Merged

Update and rename README.rst to README.md #387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6118e2b
Update and rename README.rst to README.md
a-velasco May 28, 2025
e138e28
format directories as code
a-velasco May 29, 2025
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
29 changes: 13 additions & 16 deletions README.rst → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,34 @@
Canonical's Sphinx Starter Pack
===============================
# Canonical's Sphinx Starter Pack

*A pre-configured repository to build and publish documentation with Sphinx.*

Description
-----------
## Description

The Documentation starter pack includes:

* A bundled Sphinx_ theme, configuration, and extensions
* A bundled [Sphinx] theme, configuration, and extensions
* Support for both reStructuredText (reST) and MyST Markdown
* Build checks for links, spelling, and inclusive language
* Customisation support layered over a core configuration

See the full documentation: https://canonical-starter-pack.readthedocs-hosted.com/

Structure
---------
## Structure

This section outlines the structure of this repository, and some key files.


docs
****
### `docs/`

This directory contains the documentation for the starter pack itself.
To view it in your browser, change to this directory and type `make run`.

tests
*****
To view it in your browser, navigate to this directory and type `make run`.

### `.github/workflows/`

This directory contains files used for documentation build checks via GitHub's CI.

This directory contains files used to test the functionality of the starter pack project.
The file `test-starter-pack.yml` tests the functionality of the starter pack project.

.. LINKS
<!--Links-->

.. _`Sphinx`: https://www.sphinx-doc.org/
[Sphinx]: https://www.sphinx-doc.org/