Skip to content

Commit

Permalink
Docs changes: fix broken links (#372)
Browse files Browse the repository at this point in the history
* update intersphinx mapping link
* fix broken label and internal links for conditional logic section
* fix label for select next frame section and internal links
* add E (fresh-env) option to docs build to build all files instead of just new/changed
  • Loading branch information
becky-gilbert authored May 8, 2024
1 parent b18afd9 commit 74380a8
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS ?= -E
SPHINXBUILD ?= sphinx-build
SOURCEDIR = ./app
BUILDDIR = _build
Expand Down
2 changes: 1 addition & 1 deletion app/components/exp-frame-base/conditional_logic.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _Conditional logic:
.. _conditional_logic:

Conditional logic
-----------------
Expand Down
2 changes: 1 addition & 1 deletion app/components/exp-frame-base/doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ language [String]

There are several parameters that ALL frames accept to allow you to customize the study "flow," which are:

.. _select next frame:
.. _selectnextframe:

selectNextFrame [String]
Function to select which frame index to go to when using the 'next' action on this
Expand Down
4 changes: 2 additions & 2 deletions app/components/exp-frame-select/doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ list of indices of which ones to actually show.

The frame(s) will be inserted into the sequence of frames for this study on the fly, so that you can use a custom
:ref:`generateProperties<generateProperties>` function to select which frame(s) to show. (For more information on
making study behavior conditional on data collected, see :ref:`conditional_logic`.)
making study behavior conditional on data collected, see :ref:`Conditional Logic<conditional_logic>`.)

This frame serves as a wrapper for the randomizer :ref:`select<select>`,
which is evaluated during experiment parsing and cannot be modified on the fly.
Expand All @@ -20,7 +20,7 @@ Warning: no ``selectNextFrame`` available
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To avoid unpredictable behavior, this frame does not itself use any
:ref:`selectNextFrame<selectNextFrame>` passed to it. (Frames *within* the ``frameOptions`` list are welcome to make use of
:ref:`selectNextFrame<selectnextframe>` passed to it. (Frames *within* the ``frameOptions`` list are welcome to make use of
``selectNextFrame``, though!)

Finding data from frames created by exp-lookit-select
Expand Down
2 changes: 1 addition & 1 deletion app/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
# ones.
extensions = ['sphinx.ext.intersphinx']

intersphinx_mapping = {'docs': ('https://lookit.readthedocs.io/en/latest/', None)}
intersphinx_mapping = {'docs': ('https://lookit.readthedocs.io/en/develop/', None)}


# Add any paths that contain templates here, relative to this directory.
Expand Down
2 changes: 1 addition & 1 deletion app/randomizers/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For complex counterbalancing designs, this may be simpler to reason about and de
without having to learn any special Lookit syntax. See :ref:`'Protocol generators'<generators>` for more information.

A protocol generator function can do anything that a randomizer frame can do. But to set up
:ref:`conditional logic<Conditional logic>` (doing different things depending on what the family does *this session*),
:ref:`conditional logic<conditional_logic>` (doing different things depending on what the family does *this session*),
you will still need to use ``generateProperties`` or ``selectNextFrame`` parameters within the protocol you generate.

3. Randomizer frames
Expand Down

0 comments on commit 74380a8

Please sign in to comment.