Recent changes to Home

WikiPage Home modified by John R. Cary

John R. Cary — Sun, 07 Oct 2012 16:39:33 -0000

--- v3
+++ v4
@@ -10,8 +10,8 @@
 Installation
 ------------
 
- * Make sure that you can run python -c "import sphinx"
- * Download the latest tarball, untar it, and run install.sh.
+ * Make sure that you can run "python -c 'import sphinx'".
+ * Download the latest tarball, untar it, and run "python setup.py install".
 
 Configuration
 -------------

WikiPage Home modified by John R. Cary

John R. Cary — Sun, 07 Oct 2012 15:25:31 -0000

--- v2
+++ v3
@@ -6,6 +6,23 @@
 This originated originated from 
 https://bitbucket.org/arjones6/sphinx-numfig/wiki/Home.
 The changes have been to get it to work with html, to namespace the configuration parameters, and to give more descriptive names to various methods.
+
+Installation
+------------
+
+ * Make sure that you can run python -c "import sphinx"
+ * Download the latest tarball, untar it, and run install.sh.
+
+Configuration
+-------------
+
+In your project's conf.py, add numfig to your sphinx extensions, and set the values of your configuration parameters as shown in the fragment below.
+
+    extensions = ['sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.numfig']
+
+    # numfig:
+    # numfig_number_figures = True
+    # numfig_figure_caption_prefix = "Figure"
 
 Usage
 -----
@@ -22,12 +39,9 @@
 
        Setup window for the Electromagnetic Plane Wave example.
 
-The label (_emPlaneWaveSetupWin:) has an underscore prepended and 
-a colon appended.
+The label (_emPlaneWaveSetupWin:) has an underscore prepended and a colon appended.
 
-The reference (#emplanewavesetupwin) is a translation of the label to 
-lower case with all dashes converted to underscores with a hash sign 
-prepended.
+The reference (#emplanewavesetupwin) is a translation of the label to lower case with all dashes converted to underscores with a hash sign prepended.
 
 The figure caption must be separated from the figure by an empty line.

WikiPage Home modified by John R. Cary

John R. Cary — Sun, 07 Oct 2012 15:20:58 -0000

--- v1
+++ v2
@@ -1,6 +1,35 @@
-Welcome to your wiki!
+Numfig: a Sphinx package for numbering figures
+==============================================
 
-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+With numfig you can have numbered figures in your Sphinx documents and refer to them by number.
+
+This originated originated from 
+https://bitbucket.org/arjones6/sphinx-numfig/wiki/Home.
+The changes have been to get it to work with html, to namespace the configuration parameters, and to give more descriptive names to various methods.
+
+Usage
+-----
+
+Example of use:
+
+    A visualization of this is shown in :num:`Fig. #emplanewavesetupwin`.
+
+    .. _emPlaneWaveSetupWin:
+
+    .. figure:: emPlaneWaveSetupWin.png
+       :scale: 100 %
+       :alt: image 1
+
+       Setup window for the Electromagnetic Plane Wave example.
+
+The label (_emPlaneWaveSetupWin:) has an underscore prepended and 
+a colon appended.
+
+The reference (#emplanewavesetupwin) is a translation of the label to 
+lower case with all dashes converted to underscores with a hash sign 
+prepended.
+
+The figure caption must be separated from the figure by an empty line.
 
 The wiki uses [Markdown](/p/numfig/wiki/markdown_syntax/) syntax.

WikiPage Home modified by John R. Cary

John R. Cary — Sun, 07 Oct 2012 09:24:45 -0000

Welcome to your wiki! This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage]. The wiki uses [Markdown](/p/numfig/wiki/markdown_syntax/) syntax. [[project_admins]] [[download_button]]