diff options
| author | Joe Gordon <jogo@pinterest.com> | 2022-07-22 10:05:48 -0700 |
|---|---|---|
| committer | Joe Gordon <jogo@pinterest.com> | 2022-07-22 10:21:34 -0700 |
| commit | f7db8bb8c6d1db081859805de0c9d571276b5dd7 (patch) | |
| tree | f2fdbad2fcfeb5768e32e18cc1983973ef957db9 /docs | |
| parent | b86bb741884b19266596c5c10159f588ec9b8b77 (diff) | |
| download | pymemcache-f7db8bb8c6d1db081859805de0c9d571276b5dd7.tar.gz | |
Fix docs
* autodoc wasn't generating docs correnctly
* add pytest so sphinx can render test docs, excluding them from docs
for now though (so generated, but no link to them)
* Update version info in docs/conf.py
* Fix a few sphinx warnings
* Add in changelog into docs and switch to toctree depth of 1, as the
changelog has a lat of H2 headers.
* Add docs to CI
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 1 | ||||
| -rw-r--r-- | docs/conf.py | 8 | ||||
| -rw-r--r-- | docs/getting_started.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 3 |
4 files changed, 9 insertions, 7 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..91bdab9 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1 @@ +.. include:: ../ChangeLog.rst diff --git a/docs/conf.py b/docs/conf.py index b781a5a..c78990a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ import os import sys import subprocess -sys.path.insert(0, os.path.abspath(".")) +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -65,9 +65,9 @@ author = "Charles Gordon, Jon Parise, Joe Gordon" # built documents. # # The short X.Y version. -version = "3.2" +version = "3.5" # The full version, including alpha/beta/rc tags. -release = "3.2.0" +release = "3.5.2" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -358,5 +358,5 @@ intersphinx_mapping = {"https://docs.python.org/": None} # Automate building apidoc when building with readthedocs apidoc_module_dir = os.path.join("..", "pymemcache") apidoc_output_dir = "apidoc" +apidoc_excluded_paths = ["test", "setup.py"] apidoc_separate_modules = True -apidoc_extra_args = ["--force"] diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 0107af7..a88e1be 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -99,7 +99,7 @@ follows: - ``key4`` -> ``node1`` - ``key5`` -> ``node2`` -3. Subsequent ``get``s will hash to the correct server and requests are routed +3. Subsequent ``get`` calls will hash to the correct server and requests are routed accordingly. 4. ``node3`` goes down. 5. The hashclient tries to ``get("key2")`` but detects the node as down. This @@ -253,7 +253,7 @@ One main advantage of using `tox` to interact with `pymemcache` is that it comes with it's own virtual environments. It will automatically install pymemcache and fetch all the needed requirements at run. See the example below: -.. code-block:: shell +.. code-block:: $ podman run --publish 11211:11211 -it --rm --name memcached memcached $ tox -e venv -- python diff --git a/docs/index.rst b/docs/index.rst index 9d3b828..9bb44dc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,10 +9,11 @@ Welcome to pymemcache's documentation! Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 Getting Started </getting_started> Source Code </apidoc/modules> + ChangeLog </changelog> |