karaolidis/fbchat
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small doc fixes

Browse Source
This commit is contained in:
Mads Marquart
2020-01-22 23:55:54 +01:00
parent 55ef9979c3
commit 0fd58c52ea
6 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api/index.rst
View File

@@ -1,5 +1,4 @@
.. module:: fbchat
.. _api:
.. Note: we're using () to hide the __init__ method where relevant

2
docs/conf.py
View File

@@ -162,7 +162,7 @@ epub_exclude_files = ["search.html"]
# -- Options for autodoc extension ---------------------------------------
autoclass_content = "both"
autoclass_content = "class"
autodoc_member_order = "bysource"
autodoc_default_options = {"members": True}

2
docs/faq.rst
View File

@@ -6,7 +6,7 @@ The new version broke my application
``fbchat`` follows `Scemantic Versioning <https://semver.org/>`__ quite rigorously!
That means that breaking changes can *only* occur in major versions (e.g. `v1.9.6` -> `v2.0.0`).
That means that breaking changes can *only* occur in major versions (e.g. ``v1.9.6`` -> ``v2.0.0``).
If you find that something breaks, and you didn't update to a new major version, then it is a bug, and we would be grateful if you reported it!