Skip to content

Commit

Permalink
Docs: update requirements and theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kijewski committed Jun 23, 2023
1 parent c2750d6 commit fcd7a8d
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 47 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- macos-latest
- windows-latest
python:
- '3.7'
- '3.8'
- '3.11'

steps:
Expand Down
28 changes: 1 addition & 27 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,35 +35,9 @@
pygments_style = 'sphinx'
todo_include_todos = False

html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'navigation_depth': -1,
}
html_sidebars = {
'**': [
'localtoc.html',
'searchbox.html',
]
}
html_theme = 'furo'
htmlhelp_basename = 'PyJSON5doc'

latex_elements = {}
latex_documents = [
(master_doc, 'PyJSON5.tex', u'PyJSON5 Documentation',
u'René Kijewski', 'manual'),
]

man_pages = [
(master_doc, 'pyjson5', u'PyJSON5 Documentation',
[author], 1)
]

texinfo_documents = [
(master_doc, 'PyJSON5', u'PyJSON5 Documentation',
author, 'PyJSON5', 'One line description of project.',
'Miscellaneous'),
]

display_toc = True
autodoc_default_flags = ['members']
autosummary_generate = True
Expand Down
12 changes: 6 additions & 6 deletions docs/decoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,26 +59,26 @@ Decoder Exceptions
pyjson5.Json5ExtraData
pyjson5.Json5IllegalType

.. autoclass:: pyjson5.Json5DecoderException
.. autoexception:: pyjson5.Json5DecoderException
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5NestingTooDeep
.. autoexception:: pyjson5.Json5NestingTooDeep
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5EOF
.. autoexception:: pyjson5.Json5EOF
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5IllegalCharacter
.. autoexception:: pyjson5.Json5IllegalCharacter
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5ExtraData
.. autoexception:: pyjson5.Json5ExtraData
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5IllegalType
.. autoexception:: pyjson5.Json5IllegalType
:members:
:inherited-members:
4 changes: 2 additions & 2 deletions docs/encoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ Encoder Exceptions
pyjson5.Json5EncoderException
pyjson5.Json5UnstringifiableType

.. autoclass:: pyjson5.Json5EncoderException
.. autoexception:: pyjson5.Json5EncoderException
:members:
:inherited-members:

.. autoclass:: pyjson5.Json5UnstringifiableType
.. autoexception:: pyjson5.Json5UnstringifiableType
:members:
:inherited-members:
2 changes: 1 addition & 1 deletion docs/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Exceptions
pyjson5.Json5ExtraData
pyjson5.Json5IllegalType

.. autoclass:: pyjson5.Json5Exception
.. autoexception:: pyjson5.Json5Exception
:members:
:inherited-members:
10 changes: 5 additions & 5 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ black
build
colorama == 0.4.*
cython == 0.*
more_itertools == 8.*
more_itertools == 9.*
mypy
setuptools
wheel

# keep synchronous to requirements-readthecocs.txt
docutils == 0.17.*
myst-parser == 0.18.*
sphinx == 5.*
docutils == 0.19.*
furo
myst-parser == 2.*
sphinx == 7.*
sphinx_autodoc_typehints == 1.*
sphinx_rtd_theme == 1.*
8 changes: 4 additions & 4 deletions requirements-readthedocs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
pyjson5 == 1.6.3

# keep synchronous to requirements-dev.txt
docutils == 0.17.*
myst-parser == 0.18.*
sphinx == 5.*
docutils == 0.19.*
furo
myst-parser == 2.*
sphinx == 7.*
sphinx_autodoc_typehints == 1.*
sphinx_rtd_theme == 1.*

0 comments on commit fcd7a8d

Please sign in to comment.