Skip to content

Update README to use makefile #157

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to use makefile #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 5 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

<picture>
Expand All @@ -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

Expand All @@ -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
```
Loading