mirror of
https://github.com/django-components/django-components.git
synced 2025-09-19 04:09:44 +00:00
docs: document how to serve documentation website (#1391)
Some checks are pending
Docs - build & deploy / docs (push) Waiting to run
Run tests / build (ubuntu-latest, 3.10) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.8) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.9) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.11) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.12) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.13) (push) Waiting to run
Run tests / build (windows-latest, 3.10) (push) Waiting to run
Run tests / build (windows-latest, 3.11) (push) Waiting to run
Run tests / build (windows-latest, 3.12) (push) Waiting to run
Run tests / build (windows-latest, 3.13) (push) Waiting to run
Run tests / test_docs (3.13) (push) Waiting to run
Run tests / test_sampleproject (3.13) (push) Waiting to run
Run tests / build (windows-latest, 3.8) (push) Waiting to run
Run tests / build (windows-latest, 3.9) (push) Waiting to run
Some checks are pending
Docs - build & deploy / docs (push) Waiting to run
Run tests / build (ubuntu-latest, 3.10) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.8) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.9) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.11) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.12) (push) Waiting to run
Run tests / build (ubuntu-latest, 3.13) (push) Waiting to run
Run tests / build (windows-latest, 3.10) (push) Waiting to run
Run tests / build (windows-latest, 3.11) (push) Waiting to run
Run tests / build (windows-latest, 3.12) (push) Waiting to run
Run tests / build (windows-latest, 3.13) (push) Waiting to run
Run tests / test_docs (3.13) (push) Waiting to run
Run tests / test_sampleproject (3.13) (push) Waiting to run
Run tests / build (windows-latest, 3.8) (push) Waiting to run
Run tests / build (windows-latest, 3.9) (push) Waiting to run
This commit is contained in:
parent
8a6215b9cd
commit
7fad7f9ccd
1 changed files with 37 additions and 0 deletions
|
@ -185,6 +185,43 @@ twine upload --repository pypi dist/* -u __token__ -p <PyPI_TOKEN>
|
|||
|
||||
[See the full workflow here.](https://github.com/django-components/django-components/discussions/557#discussioncomment-10179141)
|
||||
|
||||
## Documentation website
|
||||
|
||||
The documentation website is built using [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
|
||||
|
||||
First install dependencies needed for the documentation:
|
||||
|
||||
```sh
|
||||
pip install -r requirements-docs.txt
|
||||
```
|
||||
|
||||
Then install this local django-components version. Use `-e` for [editable mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html) so you don't have to re-install after every change:
|
||||
|
||||
```sh
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
To run the documentation server locally, run:
|
||||
|
||||
```sh
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
Then open <http://127.0.0.1:9000/django-components/> in your browser.
|
||||
|
||||
To just build the documentation, run:
|
||||
|
||||
```sh
|
||||
mkdocs build
|
||||
```
|
||||
|
||||
The documentation site is deployed automatically with Github actions (see [`.github/workflows/docs.yml`](https://github.com/django-components/django-components/blob/master/.github/workflows/docs.yml)).
|
||||
|
||||
The CI workflow runs when:
|
||||
|
||||
- A new commit is pushed to the `master` branch - This updates the `dev` version
|
||||
- A new tag is pushed - This updates the `latest` version and the version specified in the tag name
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Updating supported versions
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue