Skip to content

Commit fcd7a8d

Browse files
committed
Docs: update requirements and theme
1 parent c2750d6 commit fcd7a8d

8 files changed

+21
-47
lines changed

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
- macos-latest
1313
- windows-latest
1414
python:
15-
- '3.7'
15+
- '3.8'
1616
- '3.11'
1717

1818
steps:

docs/conf.py

+1-27
Original file line numberDiff line numberDiff line change
@@ -35,35 +35,9 @@
3535
pygments_style = 'sphinx'
3636
todo_include_todos = False
3737

38-
html_theme = 'sphinx_rtd_theme'
39-
html_theme_options = {
40-
'navigation_depth': -1,
41-
}
42-
html_sidebars = {
43-
'**': [
44-
'localtoc.html',
45-
'searchbox.html',
46-
]
47-
}
38+
html_theme = 'furo'
4839
htmlhelp_basename = 'PyJSON5doc'
4940

50-
latex_elements = {}
51-
latex_documents = [
52-
(master_doc, 'PyJSON5.tex', u'PyJSON5 Documentation',
53-
u'René Kijewski', 'manual'),
54-
]
55-
56-
man_pages = [
57-
(master_doc, 'pyjson5', u'PyJSON5 Documentation',
58-
[author], 1)
59-
]
60-
61-
texinfo_documents = [
62-
(master_doc, 'PyJSON5', u'PyJSON5 Documentation',
63-
author, 'PyJSON5', 'One line description of project.',
64-
'Miscellaneous'),
65-
]
66-
6741
display_toc = True
6842
autodoc_default_flags = ['members']
6943
autosummary_generate = True

docs/decoder.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,26 @@ Decoder Exceptions
5959
pyjson5.Json5ExtraData
6060
pyjson5.Json5IllegalType
6161

62-
.. autoclass:: pyjson5.Json5DecoderException
62+
.. autoexception:: pyjson5.Json5DecoderException
6363
:members:
6464
:inherited-members:
6565

66-
.. autoclass:: pyjson5.Json5NestingTooDeep
66+
.. autoexception:: pyjson5.Json5NestingTooDeep
6767
:members:
6868
:inherited-members:
6969

70-
.. autoclass:: pyjson5.Json5EOF
70+
.. autoexception:: pyjson5.Json5EOF
7171
:members:
7272
:inherited-members:
7373

74-
.. autoclass:: pyjson5.Json5IllegalCharacter
74+
.. autoexception:: pyjson5.Json5IllegalCharacter
7575
:members:
7676
:inherited-members:
7777

78-
.. autoclass:: pyjson5.Json5ExtraData
78+
.. autoexception:: pyjson5.Json5ExtraData
7979
:members:
8080
:inherited-members:
8181

82-
.. autoclass:: pyjson5.Json5IllegalType
82+
.. autoexception:: pyjson5.Json5IllegalType
8383
:members:
8484
:inherited-members:

docs/encoder.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ Encoder Exceptions
6464
pyjson5.Json5EncoderException
6565
pyjson5.Json5UnstringifiableType
6666

67-
.. autoclass:: pyjson5.Json5EncoderException
67+
.. autoexception:: pyjson5.Json5EncoderException
6868
:members:
6969
:inherited-members:
7070

71-
.. autoclass:: pyjson5.Json5UnstringifiableType
71+
.. autoexception:: pyjson5.Json5UnstringifiableType
7272
:members:
7373
:inherited-members:

docs/exceptions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ Exceptions
1212
pyjson5.Json5ExtraData
1313
pyjson5.Json5IllegalType
1414

15-
.. autoclass:: pyjson5.Json5Exception
15+
.. autoexception:: pyjson5.Json5Exception
1616
:members:
1717
:inherited-members:

requirements-dev.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ black
22
build
33
colorama == 0.4.*
44
cython == 0.*
5-
more_itertools == 8.*
5+
more_itertools == 9.*
66
mypy
77
setuptools
88
wheel
99

1010
# keep synchronous to requirements-readthecocs.txt
11-
docutils == 0.17.*
12-
myst-parser == 0.18.*
13-
sphinx == 5.*
11+
docutils == 0.19.*
12+
furo
13+
myst-parser == 2.*
14+
sphinx == 7.*
1415
sphinx_autodoc_typehints == 1.*
15-
sphinx_rtd_theme == 1.*

requirements-readthedocs.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
pyjson5 == 1.6.3
44

55
# keep synchronous to requirements-dev.txt
6-
docutils == 0.17.*
7-
myst-parser == 0.18.*
8-
sphinx == 5.*
6+
docutils == 0.19.*
7+
furo
8+
myst-parser == 2.*
9+
sphinx == 7.*
910
sphinx_autodoc_typehints == 1.*
10-
sphinx_rtd_theme == 1.*

0 commit comments

Comments
 (0)