Commit Graph

34 Commits

Author SHA1 Message Date
LJFP
c44f6f6372 Fix Makefile and make.bat files for doc generation using sphinx-build. They were using a non-existent Builder called "help". I changed it to "html" since that is the one used by sphinx-autobuild. 2024-09-05 10:02:48 +02:00
Matthew Foster Walsh
10c85ce3d6
Rename docker compose files to include 'docker-compose' (#4995)
* Renamed local.yml to docker-compose.local.yml

* Renamed production.yml to docker-compose.production.yml

* Rename docs.yml to docker-compose.docs.yml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
2024-05-13 18:18:56 +01:00
Ryan Fitch
b15cae614a
Fix broken link for sphinx-doc in generated docs (#5015) 2024-04-22 10:10:25 +01:00
Jelmer Draaijer
0fc4ea6165 Apply ruff to codebase 2024-02-13 11:59:55 +01:00
Imran Rahman
f567b5f685
update docs docker-compose -> docker compose (#4463)
Co-authored-by: Imran Rahman <imranrahman.ix@gmail.com>
2023-07-24 10:42:51 +01:00
masavini
1ed6d6e03b
VS Code Dev Container (#4198)
* decontainer setup

* update

* fix typo

* keep .envs

* add info

* typo

* minor fixes

* keep compose/production

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add isort and lint

* choose editor and configure devcontainer

* choose editor and configure devcontainer

* add ssh client

* Remove isort arguments duplicated with base config

* End of file

* Only keep black as code formatter

* Add note about black not being accepted as formatter in devcontainer

* Avoid empty lines in devcontainer.json

* Move bash_history into .devcontainer folder

* Remove .prettierignore file

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2023-07-03 11:55:33 +02:00
Artur Barseghyan
bfb7e0b2a4
Fix a few typos in the documentation (#3625) 2022-03-09 16:25:00 +00:00
Andrew Chen Wang
85ee3c921a
Change docs port to 9000 from 7000 (#3590)
Signed-off-by: Andrew-Chen-Wang <acwangpython@gmail.com>
2022-02-13 12:49:05 +00:00
Bruno Alla
a9a344a8bc
Merge pull request #3380 from d57montes/fix-help-docs-makefile 2021-11-04 15:02:50 +00:00
Diego Montes
51c149f137
remove if else block in docs makefile 2021-11-04 08:39:00 -04:00
Diego Montes
faf477a868
change catch-all -b option as well 2021-11-03 19:41:08 -04:00
Diego Montes
c2af9c3134 fix help in docs Makefile 2021-11-03 17:03:47 -04:00
Diego Montes
ce5223fe59 change path in docs Makefile to use APP variable 2021-11-03 16:15:40 -04:00
Bruno Alla
57f9ff571b
Merge pull request #3139 from fhightower/patch-1
Removing pycharm docs if app does not use pycharm
2021-09-11 17:55:10 +01:00
Andrew Chen Wang
4214b1b8ef
Update docs/howto.rst 2021-06-20 12:47:07 -04:00
Floyd Hightower
7b4a0bafb6
Removing pycharm docs if app does not use pycharm 2021-04-26 06:43:52 -04:00
Andrew Chen Wang
72da0bfa9c
Fix docs service and add RTD support (#2920)
Co-authored-by: Andrew-Chen-Wang <Andrew-Chen-Wang@users.noreply.github.com>
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-11-04 17:17:02 +00:00
Bruno Alla
0b3dd776c6
Fix options for sphinx-autobuild in docs Makefile (#2799)
Fix #2796
2020-09-07 14:06:18 +01:00
Hannah Lazarus
916157e500
Update {{cookiecutter.project_slug}}/docs/_source/howto.rst
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-06-27 14:11:57 -04:00
Hannah Lazarus
3152bdaeb3 Add sphinx defaults for cookiecutter'd project
-serve, watch + live reload for docs + code file changes
-update project makefile + make.bat
-separate _source and _build
-add packages and paths to use autodoc
-edit/add documentation with examples (both at django-cookiecutter and inside generated project)
-add formatted comments in User model for pickup by Sphinx apidoc
-serve docs from a separate docs container for docker build
2020-04-30 13:23:24 -04:00
Tim Gates
62236dd908
docs: Fix simple typo, interpteter -> interpreter
There is a small typo in {{cookiecutter.project_slug}}/docs/pycharm/configuration.rst.

Should read `interpreter` rather than `interpteter`.
2020-03-27 22:15:56 +11:00
howiezhao
2f9d693980
style: formatting code 2020-01-16 11:31:37 +08:00
howiezhao
16b219034a Update docs files 2019-12-28 17:26:43 +08:00
Min ho Kim
62df724c8c Fix typo 2019-06-15 06:37:58 +10:00
Nikita P. Shupeyko
3a17f9bc27 Remove project doc files likely to remain unused 2018-05-25 12:16:04 +03:00
Daniel Roy Greenfeld
3f753e0411
First pass at running black across the project (#1602) 2018-04-08 17:03:29 -05:00
Reggie Riser
f7bd7a5814 Fixing leftovers from migration to Django 1.11 and Python 3.6. 2018-01-03 08:44:54 -05:00
Shupeyko Nikita
833a79ff3c Remove pycharm service from Docker setup (#1307)
* Remove pycharm service from Docker setup

* Update generated project docs
2017-08-31 19:25:58 +03:00
Shupeyko Nikita
e889316b11 Rename dev.yml to local.yml (#1227)
* Rename dev.yml to local.yml

Closes #1226.

* Rename docker-compose.yml to production.yml
2017-07-14 17:09:41 +03:00
Daniel Roy Greenfeld
6aced9ba73 Remove Python 2.7 support per #1129 (#1130)
* Remove Python 2.7 support per

* Remove Python 2.7 references

* Remove Python 2.7 references

* remove python 2 entirely
2017-04-21 12:31:45 -07:00
Reggie Riser
2006605e24 A few cleanups: 1) Fixed common.py references (now called base.py), 2) Made URLs consistent in pointing to dev Django docs as well as https, (#1037) 2017-02-21 11:55:51 -08:00
Mounir
489c971123 pycharm doc typo (#1042)
* pycharm doc typo

a very simple typo in the word without

* Update configuration.rst
2017-02-20 14:23:18 +01:00
Daniel Roy Greenfeld
b2d0a86344 simplify cookiecutter.json 2016-06-04 17:16:48 -07:00
Audrey Roy Greenfeld
15f350f05e Change repo_name to project_slug for clarity. 2016-04-20 10:00:35 -07:00