Merge pull request #1256 from bjones1/docs_update

bnmnetp · web-flow · commit c2a51ff576f8 · 2021-09-28T08:56:12.000-05:00
Docs update
diff --git a/index.rst b/index.rst
@@ -24,6 +24,8 @@ Components
     runestone/*/toctree
     runestone/__init__.py
     runestone/__main__.py
+    runestone/conftest.py
+    runestone/shared_conftest.py
     runestone/unittest_base.py
 
 
@@ -35,6 +37,7 @@ Packaging
     setup.py
     setup.cfg
     MANIFEST.in
+    webpack.config.js
 
 Misc
 ====
@@ -44,11 +47,11 @@ Misc
     ACKNOWLEDGEMENTS
     .github/FUNDING.yml
     .gitignore
+    .github/workflows/python-package.yml
     .readthedocs.yml
     conf.py
     codechat_config.yaml
     requirements-dev.in
     requirements.in
-    webpack.config.js
     public/index.html
     makeRelease.sh
diff --git a/runestone/activecode/toctree.rst b/runestone/activecode/toctree.rst
@@ -1,6 +1,8 @@
 *************************************************
-ActiveCode
+ActiveCode - Run code in the browser
 *************************************************
+See the `overview <https://runestone.academy/runestone/books/published/overview/ActiveCode/toctree.html>`_.
+
 .. toctree::
     :maxdepth: 1
     :glob:
diff --git a/runestone/assignment/__init__.py b/runestone/assignment/__init__.py
@@ -1,3 +1,7 @@
+# ***********************************************
+# |docname| - Define the ``assignment`` directive
+# ***********************************************
+#
 # Copyright (C) 2015  Paul Resnick
 #
 # This program is free software: you can redistribute it and/or modify
diff --git a/runestone/assignment/toctree.rst b/runestone/assignment/toctree.rst
@@ -1,11 +1,7 @@
-*************************************************
-Accessibility
-*************************************************
+**************************************************
+Assignment - directives for creating an assignment
+**************************************************
 .. toctree::
     :maxdepth: 1
-    :glob:
 
-    *.py
-    js/*.js
-    css/*.css
-    test/test_*.py
+    __init__.py
diff --git a/runestone/blockly/toctree.rst b/runestone/blockly/toctree.rst
@@ -1,11 +1,11 @@
-*************************************************
-Accessibility
-*************************************************
+********************************************************
+Blockly - Embed block-based code generation in Runestone
+********************************************************
+Warning: This component is deprecated. Do not use it in new books.
+
 .. toctree::
     :maxdepth: 1
     :glob:
 
+    README
     *.py
-    js/*.js
-    css/*.css
-    test/test_*.py
diff --git a/runestone/fitb/fitb.py b/runestone/fitb/fitb.py
@@ -1,6 +1,6 @@
-# *********
-# |docname|
-# *********
+# ******************************************************************
+# |docname| - Provide Sphinx support for fill-in-the-blank questions
+# ******************************************************************
 #
 # .. Copyright (C) 2013  Bradley N. Miller
 #
diff --git a/runestone/mchoice/assess.py b/runestone/mchoice/assess.py
@@ -85,15 +85,25 @@ def run(self):
 
 
 class QuestionNumber(RunestoneDirective):
-    """Set Parameters for Question Numbering
-.. qnum::
-   'prefix': character prefix before the number
-   'suffix': character prefix after the number
-   'start': start numbering with this value
-
-.. qnum::
-   :prefix: turtle-
-   :start: 10
+    """
+    Set Parameters for Question Numbering:
+
+    .. code-block:: rst
+        :linenos:
+
+        .. qnum::
+            'prefix': character prefix before the number
+            'suffix': character prefix after the number
+            'start': start numbering with this value
+
+    For example:
+
+    .. code-block:: rst
+        :linenos:
+
+        .. qnum::
+            :prefix: turtle-
+            :start: 10
     """
 
     required_arguments = 0
diff --git a/runestone/selectquestion/toctree.rst b/runestone/selectquestion/toctree.rst
@@ -0,0 +1,12 @@
+*************************************************
+Dynamic Questions
+*************************************************
+See the `overview book <https://runestone.academy/runestone/books/published/overview/Containers/dynamic.html>`_ for user documentation.
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *.py
+    js/*.js
+    css/*.css
diff --git a/runestone/timed/toctree.rst b/runestone/timed/toctree.rst
@@ -1,6 +1,8 @@
 *************************************************
-Accessibility
+Timed Exam Questions
 *************************************************
+See the `overview book <https://runestone.academy/runestone/books/published/overview/Assessments/timed.html>`_ for user documentation.
+
 .. toctree::
     :maxdepth: 1
     :glob:

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+# ***********************************************`
	`2`	+# \|docname\| - Define the ``assignment`` directive
	`3`	`+# ***********************************************`
	`4`	`+#`
`1`	`5`	`# Copyright (C) 2015 Paul Resnick`
`2`	`6`	`#`
`3`	`7`	`# This program is free software: you can redistribute it and/or modify`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-# *********`
`2`		`-# \|docname\|`
`3`		`-# *********`
	`1`	`+# ******************************************************************`
	`2`	`+# \|docname\| - Provide Sphinx support for fill-in-the-blank questions`
	`3`	`+# ******************************************************************`
`4`	`4`	`#`
`5`	`5`	`# .. Copyright (C) 2013 Bradley N. Miller`
`6`	`6`	`#`