Skip to content

Commit

Permalink
Update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Jul 8, 2024
1 parent f87bb56 commit 28dfc24
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 137 deletions.
3 changes: 3 additions & 0 deletions {{cookiecutter.project_name}}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -250,3 +250,6 @@ artifacts/

# import-linter:
.import_linter_cache/

# safety:
.safety/
2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS=
SPHINXOPTS=-W
SPHINXBUILD=python -msphinx
SPHINXPROJ={{cookiecutter.project_name}}
SOURCEDIR=.
Expand Down
7 changes: 5 additions & 2 deletions {{cookiecutter.project_name}}/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ def _get_project_meta() -> dict[str, str]: # lying about return type
'sphinx.ext.githubpages',
'sphinx.ext.napoleon',

# https://github.com/executablebooks/MyST-Parser
'myst_parser',

# 3rd party, order matters:
# https://github.com/wemake-services/wemake-django-template/issues/159
'sphinx_autodoc_typehints',
Expand All @@ -80,7 +83,7 @@ def _get_project_meta() -> dict[str, str]: # lying about return type

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst']
source_suffix = ['.rst', '.md']

# The master toctree document.
master_doc = 'index'
Expand All @@ -95,7 +98,7 @@ def _get_project_meta() -> dict[str, str]: # lying about return type
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down
1 change: 1 addition & 0 deletions {{cookiecutter.project_name}}/docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ if "%SPHINXBUILD%" == "" (
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=wemake-django-template
set SPHINXOPTS=-W

if "%1" == "" goto help

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ To install dependencies for production use, you will need to run:
poetry install --only=main
To install all dependencies, including docs:

.. code:: bash
poetry install --with=docs
And to activate ``virtualenv`` created by ``poetry`` run:

.. code:: bash
Expand All @@ -71,6 +77,8 @@ To add a new dependency you can run:
- ``poetry add django`` to install ``django`` as a production dependency
- ``poetry add -G dev pytest`` to install ``pytest``
as a development dependency
- ``poetry add -G docs some-sphinx-plugin`` to install ``some-sphinx-plugin``
as a documentation dependency

This command might be used with ``docker``.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To install them use:

.. code:: bash
poetry install -E docs
poetry install --with=docs
Structure
Expand Down
294 changes: 162 additions & 132 deletions {{cookiecutter.project_name}}/poetry.lock

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion {{cookiecutter.project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "{{ cookiecutter.project_name }}"
description = "{{ cookiecutter.project_verbose_name }}"
version = "0.1.0"
readme = "README.md"
package-mode = false
authors = []
classifiers = [
"Private :: Do not Upload",
Expand Down Expand Up @@ -69,6 +70,7 @@ optional = true
sphinx = "^7.3"
sphinx-autodoc-typehints = "^2.2"
tomli = "^2.0"
myst-parser = "^3.0"


[build-system]
Expand All @@ -77,7 +79,7 @@ build-backend = "poetry.core.masonry.api"


[tool.djlint]
ignore = "H006,H030,H031"
ignore = "T003,H006,H030,H031"
include = "H017,H035"
indent = 2
blank_line_after_tag = "load,extends"
Expand Down

0 comments on commit 28dfc24

Please sign in to comment.