From 82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Fri, 5 Oct 2018 09:33:26 +0100 Subject: [Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py. --- docs/source/devguide/how-to/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/source/devguide/how-to/index.md (limited to 'docs/source/devguide/how-to/index.md') diff --git a/docs/source/devguide/how-to/index.md b/docs/source/devguide/how-to/index.md new file mode 100644 index 000000000..da978c16b --- /dev/null +++ b/docs/source/devguide/how-to/index.md @@ -0,0 +1,8 @@ +# How-to guides + +This is a collection of guides for specific issues or cover more details than +the tutorials. + +## Web JSON-RPC + +- [Connect to JSON-RPC using curl](curl-jsonrpc.md) -- cgit