From 4d18c9556d1c4d3ad574de4fdad56d94834bd09d Mon Sep 17 00:00:00 2001 From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Date: Sat, 24 May 2025 08:59:47 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5c0ba71..54811f8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Python Documentation Community -[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/?badge=latest) [![Python Discourse Documentation Category](https://img.shields.io/badge/discourse-join_chat-brightgreen.svg)](https://discuss.python.org/c/documentation/26) @@ -23,7 +23,7 @@ This repo serves as documentation for the Documentation Community Group. -For example, to find out more about us and what we do, [read the docs](https://docs-community.readthedocs.io/en/latest/). +For example, to find out more about us and what we do, [read the docs](https://docs-community.readthedocs.io/). ## Build docs and view changes @@ -37,19 +37,11 @@ For example, to find out more about us and what we do, [read the docs](https://d 2. Create a new Python virtual environment ```console - python -m venv docs-wg-env + make venv ``` -3. Activate the environment ([platform/shell-specific](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments)) - -4. Install dependencies - - ```console - python -m pip install -r requirements.txt - ``` - -5. Build the docs, open them in your browser and update whenever changes are made +3. Build the docs, open them in your browser and update whenever changes are made ```console - sphinx-autobuild --open-browser docs docs/_build + make html ``` From b7705922556334c8c349420313d51c6cea103251 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:37:20 +0200 Subject: [PATCH 2/2] Update README.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54811f8..4cf0beb 100644 --- a/README.md +++ b/README.md @@ -43,5 +43,5 @@ For example, to find out more about us and what we do, [read the docs](https://d 3. Build the docs, open them in your browser and update whenever changes are made ```console - make html + make htmllive ```