Skip to content

Commit 643f851

Browse files
authored
Troubleshoot PDM issue (#113)
* docs: update changelog with PDM dependency changes * fix: move dependencies to project.optional-dependencies and update changelog * chore: update pdm.lock with new dependency configuration * Refactored toml file * Refactored toml file * fix docstring errors * fix doc issues
1 parent c529751 commit 643f851

58 files changed

Lines changed: 4825 additions & 15076 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
- Fixed issue where `entry.raw` contained non-serializable Entry/Link objects, making JSON serialization fail
99
- Fixed PDM dependency configuration for CI environment
1010

11-
### Changed
12-
- Moved test and docs dependencies to project.optional-dependencies
13-
1411
## v2.4.0
1512
### Added
1613
- Added support for embargoed assets through Asset Keys

_docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
#
7979
# This is also used if you do content translation via gettext catalogs.
8080
# Usually you set "language" from the command line for these cases.
81-
language = None
81+
language = 'en'
8282

8383
# There are two options for replacing |today|: either, you set today to some
8484
# non-false value, then it is used:

_docs/contentful.rst

Lines changed: 112 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -4,147 +4,170 @@ contentful package
44
Submodules
55
----------
66

7-
contentful\.array module
8-
------------------------
7+
contentful.array module
8+
-----------------------
99

1010
.. automodule:: contentful.array
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

15-
contentful\.asset module
16-
------------------------
15+
contentful.asset module
16+
-----------------------
1717

1818
.. automodule:: contentful.asset
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
contentful.asset\_key module
24+
----------------------------
2225

23-
contentful\.client module
24-
-------------------------
26+
.. automodule:: contentful.asset_key
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
contentful.client module
32+
------------------------
2533

2634
.. automodule:: contentful.client
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
3038

31-
contentful\.content\_type module
32-
--------------------------------
39+
contentful.content\_type module
40+
-------------------------------
3341

3442
.. automodule:: contentful.content_type
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
3846

39-
contentful\.content\_type\_cache module
40-
---------------------------------------
47+
contentful.content\_type\_cache module
48+
--------------------------------------
4149

4250
.. automodule:: contentful.content_type_cache
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
4654

47-
contentful\.content\_type\_field module
48-
---------------------------------------
55+
contentful.content\_type\_field module
56+
--------------------------------------
4957

5058
.. automodule:: contentful.content_type_field
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
5462

55-
contentful\.content\_type\_field\_types module
56-
----------------------------------------------
63+
contentful.content\_type\_field\_types module
64+
---------------------------------------------
5765

5866
.. automodule:: contentful.content_type_field_types
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
6270

63-
contentful\.deleted\_asset module
64-
---------------------------------
71+
contentful.deleted\_asset module
72+
--------------------------------
6573

6674
.. automodule:: contentful.deleted_asset
67-
:members:
68-
:undoc-members:
69-
:show-inheritance:
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
7078

71-
contentful\.deleted\_entry module
72-
---------------------------------
79+
contentful.deleted\_entry module
80+
--------------------------------
7381

7482
.. automodule:: contentful.deleted_entry
75-
:members:
76-
:undoc-members:
77-
:show-inheritance:
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
7886

79-
contentful\.entry module
80-
------------------------
87+
contentful.entry module
88+
-----------------------
8189

8290
.. automodule:: contentful.entry
83-
:members:
84-
:undoc-members:
85-
:show-inheritance:
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
8694

87-
contentful\.errors module
88-
-------------------------
95+
contentful.errors module
96+
------------------------
8997

9098
.. automodule:: contentful.errors
91-
:members:
92-
:undoc-members:
93-
:show-inheritance:
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
94102

95-
contentful\.locale module
96-
-------------------------
103+
contentful.locale module
104+
------------------------
97105

98106
.. automodule:: contentful.locale
99-
:members:
100-
:undoc-members:
101-
:show-inheritance:
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
102110

103-
contentful\.resource module
104-
---------------------------
111+
contentful.resource module
112+
--------------------------
105113

106114
.. automodule:: contentful.resource
107-
:members:
108-
:undoc-members:
109-
:show-inheritance:
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
110118

111-
contentful\.resource\_builder module
112-
------------------------------------
119+
contentful.resource\_builder module
120+
-----------------------------------
113121

114122
.. automodule:: contentful.resource_builder
115-
:members:
116-
:undoc-members:
117-
:show-inheritance:
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
118126

119-
contentful\.space module
120-
------------------------
127+
contentful.space module
128+
-----------------------
121129

122130
.. automodule:: contentful.space
123-
:members:
124-
:undoc-members:
125-
:show-inheritance:
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
126134

127-
contentful\.sync\_page module
128-
-----------------------------
135+
contentful.sync\_page module
136+
----------------------------
129137

130138
.. automodule:: contentful.sync_page
131-
:members:
132-
:undoc-members:
133-
:show-inheritance:
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:
134142

135-
contentful\.utils module
136-
------------------------
143+
contentful.taxonomy\_concept module
144+
-----------------------------------
137145

138-
.. automodule:: contentful.utils
139-
:members:
140-
:undoc-members:
141-
:show-inheritance:
146+
.. automodule:: contentful.taxonomy_concept
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
142150

151+
contentful.taxonomy\_concept\_scheme module
152+
-------------------------------------------
153+
154+
.. automodule:: contentful.taxonomy_concept_scheme
155+
:members:
156+
:undoc-members:
157+
:show-inheritance:
158+
159+
contentful.utils module
160+
-----------------------
161+
162+
.. automodule:: contentful.utils
163+
:members:
164+
:undoc-members:
165+
:show-inheritance:
143166

144167
Module contents
145168
---------------
146169

147170
.. automodule:: contentful
148-
:members:
149-
:undoc-members:
150-
:show-inheritance:
171+
:members:
172+
:undoc-members:
173+
:show-inheritance:

contentful/client.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ def taxonomy_concept(self, concept_id, query=None):
370370
:param query: (optional) Dict with API options.
371371
:return: :class:`TaxonomyConcept <contentful.taxonomy_concept.TaxonomyConcept>` object.
372372
:rtype: contentful.taxonomy_concept.TaxonomyConcept
373+
373374
Usage:
374375
>>> concept = client.taxonomy_concept('3DMf5gdax6J22AfcJ6fvsC')
375376
<TaxonomyConcept id='3DMf5gdax6J22AfcJ6fvsC'>
@@ -386,6 +387,7 @@ def taxonomy_concepts(self, query=None):
386387
:param query: (optional) Dict with API options.
387388
:return: :class:`Array <contentful.array.Array>` of :class:`TaxonomyConcept <contentful.taxonomy_concept.TaxonomyConcept>` objects.
388389
:rtype: contentful.array.Array
390+
389391
Usage:
390392
>>> concepts = client.taxonomy_concepts()
391393
<Array size=1 total=1 limit=100 skip=0>
@@ -401,6 +403,7 @@ def taxonomy_concept_scheme(self, scheme_id, query=None):
401403
:param query: (optional) Dict with API options.
402404
:return: :class:`TaxonomyConceptScheme <contentful.taxonomy_concept_scheme.TaxonomyConceptScheme>` object.
403405
:rtype: contentful.taxonomy_concept_scheme.TaxonomyConceptScheme
406+
404407
Usage:
405408
>>> scheme = client.taxonomy_concept_scheme('7CzXPy6XvYYd0D7SomitgI')
406409
<TaxonomyConceptScheme id='7CzXPy6XvYYd0D7SomitgI'>
@@ -417,6 +420,7 @@ def taxonomy_concept_schemes(self, query=None):
417420
:param query: (optional) Dict with API options.
418421
:return: :class:`Array <contentful.array.Array>` of :class:`TaxonomyConceptScheme <contentful.taxonomy_concept_scheme.TaxonomyConceptScheme>` objects.
419422
:rtype: contentful.array.Array
423+
420424
Usage:
421425
>>> schemes = client.taxonomy_concept_schemes()
422426
<Array size=1 total=1 limit=100 skip=0>
@@ -704,6 +708,7 @@ def create_asset_key(self, expires_at):
704708
:param expires_at: (optional) Unix timestamp when the key should expire (max 48h from now).
705709
:return: Dict containing policy and secret for signing URLs.
706710
:rtype: dict
711+
707712
Usage:
708713
>>> asset_key = client.create_asset_key()
709714
{'policy': 'policy_string', 'secret': 'secret_string'}

docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: ca709bbe95089cf0cb344961d858e554
3+
config: 6815ab26af3771224a4470867d0b10b1
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

0 commit comments

Comments
 (0)