From 83e9e1378c66aad3f07031328e75dcbf1df8c714 Mon Sep 17 00:00:00 2001 From: ArtFlag Date: Wed, 28 Nov 2018 17:27:12 +0100 Subject: [PATCH] Create a tutorial portal --- doc/contents.rst | 1 + doc/develop.rst | 2 +- doc/extdev/index.rst | 3 ++- doc/extdev/tutorials/index.rst | 10 ++++++++++ doc/extdev/{tutorial.rst => tutorials/todo_ext.rst} | 6 +++--- doc/faq.rst | 2 +- 6 files changed, 18 insertions(+), 6 deletions(-) create mode 100644 doc/extdev/tutorials/index.rst rename doc/extdev/{tutorial.rst => tutorials/todo_ext.rst} (99%) diff --git a/doc/contents.rst b/doc/contents.rst index 36eed649e..86cacbdda 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -23,6 +23,7 @@ Sphinx documentation contents markdown extensions extdev/index + extdev/tutorials/index websupport faq diff --git a/doc/develop.rst b/doc/develop.rst index 4fc7792f7..f0ef9cec6 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -100,7 +100,7 @@ This is the current list of contributed extensions in that repository: - zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_ -See the :ref:`extension tutorial ` on getting started with writing your +See the :ref:`extension tutorial ` on getting started with writing your own extensions. diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index b6c71cca6..f948da69a 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -75,8 +75,9 @@ APIs used for writing extensions -------------------------------- .. toctree:: + :maxdepth: 2 - tutorial + tutorials/index appapi envapi builderapi diff --git a/doc/extdev/tutorials/index.rst b/doc/extdev/tutorials/index.rst new file mode 100644 index 000000000..fbcc0e001 --- /dev/null +++ b/doc/extdev/tutorials/index.rst @@ -0,0 +1,10 @@ +.. _exttuttodoorials: + +Extension tutorials +=================== + +Refer to the following tutorials to get started with extension development. + +.. toctree:: + + todo_ext \ No newline at end of file diff --git a/doc/extdev/tutorial.rst b/doc/extdev/tutorials/todo_ext.rst similarity index 99% rename from doc/extdev/tutorial.rst rename to doc/extdev/tutorials/todo_ext.rst index 33b45035e..bff369e29 100644 --- a/doc/extdev/tutorial.rst +++ b/doc/extdev/tutorials/todo_ext.rst @@ -1,7 +1,7 @@ -.. _exttut: +.. _exttuttodo: -Tutorial: Writing a simple extension -==================================== +Developing a `TODO` extension +============================= This section is intended as a walkthrough for the creation of custom extensions. It covers the basics of writing and activating an extension, as well as diff --git a/doc/faq.rst b/doc/faq.rst index 1ae9a7792..4711b7973 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -33,7 +33,7 @@ How do I... ``sidebartoc`` block. ... write my own extension? - See the :ref:`extension tutorial `. + See the :ref:`extension tutorial `. ... convert from my existing docs using MoinMoin markup? The easiest way is to convert to xhtml, then convert `xhtml to reST`_.