Skip to content

Commit

Permalink
test link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mizzao committed Jun 19, 2016
1 parent 53b99af commit 0ba1601
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 19 deletions.
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx
sphinx>=1.4.4
sphinx-autobuild
sphinx_rtd_theme
recommonmark
recommonmark>=0.4.0
11 changes: 11 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

import sphinx_rtd_theme
from recommonmark.parser import CommonMarkParser
import recommonmark
from recommonmark.transform import AutoStructify

source_parsers = {
'.md': CommonMarkParser,
Expand Down Expand Up @@ -123,6 +125,15 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# AutoStructify - see http://recommonmark.readthedocs.io/en/latest/

github_doc_root = 'https://github.com/TurkServer/docs/tree/master/source/'
def setup(app):
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
app.add_transform(AutoStructify)

# -- Options for HTML output ----------------------------------------------

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
22 changes: 11 additions & 11 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Welcome to Turkserver's documentation!
====================================
======================================

The main documentation for the site is organized into a couple sections:

* :ref:`intro-docs`
* :ref:`example-docs`
* :ref:`architecture`
* :ref:`design`
* :ref:`launching`
* :ref:`arch-docs`
* :ref:`design-docs`
* :ref:`launching-docs`

.. _intro-docs:

Expand All @@ -16,7 +16,7 @@ The main documentation for the site is organized into a couple sections:
:caption: Getting Started

intro
quickStart
quick-start

.. _example-docs:

Expand All @@ -28,7 +28,7 @@ The main documentation for the site is organized into a couple sections:
examples/tutorial
examples/research

.. _architecture:
.. _arch-docs:

.. toctree::
:maxdepth: 2
Expand All @@ -42,23 +42,23 @@ The main documentation for the site is organized into a couple sections:
arch/research-methods
arch/alternatives

.. _design:
.. _design-docs:

.. toctree::
:maxdepth: 2
:caption: Designing Experiments

design/design
design/assigning-matching
design/assigning
design/good-instructions
design/disconnection
design/one-way-mirror
design/mirror
design/debugging
design/minimizing-attrition
design/attrition
design/software
design/faq

.. _launching:
.. _launching-docs:

.. toctree::
:maxdepth: 2
Expand Down
12 changes: 6 additions & 6 deletions source/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ application platform, and providing a common system on which to build
software-based behavioral experiments, TurkServer allows for:

- **Easier real-time programming** using the [Meteor][2] web app framework
- Building synchronous experiments and studying [**group interaction**](assigning-matching)
- A live web-based [**experimenter console**](admin-console) showing all
- Building synchronous experiments and studying [group interaction](design/assigning.md)
- A live web-based [experimenter console](arch/admin-console.md) showing all
connected participants
- The ability to create [**one-way mirrors**](mirror) to view behavior
- The ability to create [one-way mirrors](design/mirror.md) to view behavior
in real time

[2]: https://www.meteor.com/
Expand Down Expand Up @@ -50,6 +50,6 @@ implement it from scratch: just grab their code and use it!

## Next Steps

Ready to jump in? Check out the [quick start](quickstart.html), a basic
(but fully functional) [tutorial app](tutorial.html), or read up on how to
think about [designing software-based online experiments](designConsiderations.html).
Ready to jump in? Check out the [quick start](quick-start.md), a basic
(but fully functional) [tutorial app](examples/tutorial.md), or read up on how to
think about [designing experiments with TurkServer](design/design.md).
File renamed without changes.

0 comments on commit 0ba1601

Please sign in to comment.