1. 07 Apr, 2017 4 commits
  2. 06 Apr, 2017 17 commits
  3. 05 Apr, 2017 8 commits
  4. 04 Apr, 2017 11 commits
    • Robert Knight's avatar
      Fix inconsistent component exports · 7974aa9c
      Robert Knight authored
      This fixes a small inconsistency in that most component modules exported
      the object defining the component directly, whereas others exported an
      object with the component as a property. There is no good reason to do
      the latter.
      7974aa9c
    • Robert Knight's avatar
      Merge pull request #335 from hypothesis/convert-mobile-docs-to-rst · a48ef194
      Robert Knight authored
      Use Sphinx environment variable cross-references
      a48ef194
    • Robert Knight's avatar
      Merge pull request #337 from hypothesis/remove-unused-vm-feature · 26f40843
      Robert Knight authored
      Remove unused vm.feature variable
      26f40843
    • Sean Hammond's avatar
      Remove unused vm.feature variable · f1ecb286
      Sean Hammond authored
      f1ecb286
    • Sean Hammond's avatar
      Just say "h" not "the h service" · 7334c86e
      Sean Hammond authored
      As unfortunate as the one-letter name is we agreed to just call it h and
      not the service, and this is how it's used elsewhere in the docs.
      7334c86e
    • Sean Hammond's avatar
      Run Sphinx in nitpicky mode · 9393af7c
      Sean Hammond authored
      This generates warnings if cross-references (for example to environment
      variables) are broken.
      9393af7c
    • Sean Hammond's avatar
      Document PACKAGE_SERVER_HOSTNAME env var · c1d49bd8
      Sean Hammond authored
      c1d49bd8
    • Sean Hammond's avatar
      Use proper Sphinx envvar cross-references · 5ce1114a
      Sean Hammond authored
      When mentioning an environment variable in Sphinx docs do this:
      
      ```
      :envvar:`FOO`
      ```
      
      This will:
      
      1. Render the envvar mention as a `<code class="std-envvar">`
         (among other CSS classes), this is then styled specially by the
         Sphinx theme
      
      2. Automatically hyperlink it to the env var's definition on the
         env vars page
      
      3. Generate a warning if an envvar with that name isn't defined
         (if the -n arg tp sphinx-build is used)
      5ce1114a
    • Sean Hammond's avatar
      Change "host name" to "hostname" · 9c055c95
      Sean Hammond authored
      This is for consistency with our variable names and, for example,
      environment variable names which use `HOSTNAME` rather than `HOST_NAME`.
      9c055c95
    • Sean Hammond's avatar
      Wrap lines in rst files to 80 chars · 1143991c
      Sean Hammond authored
      1143991c
    • Sean Hammond's avatar
      Convert mobile.md to mobile.rst · 29c168c4
      Sean Hammond authored
      I want this file to be in rst so that I can use some rst features in it
      in future commits. The main changes in order to translate from markdown
      to rst are:
      
      * Inline `<code>` requires double-backticks not single
      
      * These titles don't work:
      
        ```
        # Heading
      
        ## Subheading
        ```
      
        They should be:
      
        ```
        Heading
        =======
      
        Subheading
        ----------
        ```
      
      * To get an auto-numbered list, repeatedly using 1 doesn't work:
      
        ```
        1. First item
        1. Second item
        1. Third item
        ```
      
        Instead use `#`:
      
        ```
        #. First item
        #. Second item
        #. Third item
        ```
      
      * Paragraphs starting with `**Tip**:` (and with the contents in italics)
        now become proper tip blocks:
      
        ```
        .. tip::
      
           If the output of ``hostname`` does not include a ``.home`` or ``.local``
           suffix, you may need to append ``.local`` to get a host name that is accessible from
           other devices on the network. If you have problems using the host name, try
           using the IP address instead.
        ```
      
        Sphinx renders these boxes as `<div class="admonition tip">` and
        they're styled by your Sphinx theme (as opposed to hardcoding the tip
        is in bold and the body is italics but otherwise it's just a `<p>`).
      
      * Code blocks are like this:
      
        ```
        .. code-block:: sh
      
           First line of code
           Second line of code
        ```
      29c168c4