Vanilla Sphinx Test¶

How to use this¶

Set it up¶

Clone the repository and cd into it:

git clone git@github.com:evildmp/vanilla-sphinx-test.git
cd vanilla-sphinx-test

Set up a virtual environment and install the dependencies. Dependencies are in requirements.txt - or to create and activate the virtualenv and install the requirements using the Makefile:

make install

Use make html to build the documentation, or better, have it served on port 8000 (it will refresh the page on every save):

make run

Content examples¶

This repository is a test-bed for development of a Sphinx implementation of the Vanilla theme.

Repertoire of basic content¶

Heading¶

Sub-heading¶

Sub-sub-heading¶

Sub-sub-sub-heading¶

Sub-sub-sub-sub-heading¶

Sub-sub-sub-sub-sub-heading¶

Ordinary paragraph text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas tempus, dui in pharetra luctus, turpis nisl rhoncus tellus, vitae gravida nibh odio nec diam. Fusce non mi ut odio accumsan ultricies ut nec nulla. Phasellus nec odio sit amet neque dignissim tempor eget non ex. Aliquam sed lacinia lectus, eu congue est. Ut ac dignissim risus.

Inline markup¶

emphasis

strong emphasis

literal

Lists¶

item
item
- nested item
- nested item
item

numbered item
numbered item
1. nested numbered item
2. nested numbered item
numbered item

Code-blocks¶

@aperture.setter
def aperture(self, value):
    if value == "A":
        self.exposure_control_system.mode = "Shutter priority"

    elif not 1.7 <= value <= 16:
        raise self.ApertureOutOfRange

    else:
        self.exposure_control_system.mode = "Manual"
        self.exposure_control_system.aperture_set_lever.aperture = value

    self._aperture = value

Notes and admonitions¶

Note

Please turn the lights off if you are the last to leave.

Danger

Please turn the lights off if you are the last to leave.

Caution

Please turn the lights off if you are the last to leave.

As well as note, you can use attention, caution, danger, error, hint, important, tip, warning, seealso.

Security notice

The generic admonition directive allows you to provide a title, as above.

Tables¶

Web framework	Language	First release
Django	Python	July 2005
Ruby on Rails	Ruby	August 2004
Laravel	PHP	June 2011

Links¶

This is an example of a link to a URL

More sub-pages¶

This is another landing page providing an overview of pages in a sub-section. The pages here don’t have any meaningful content.

Page 1¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse elementum, urna et tincidunt dapibus, risus justo aliquam ligula, eget efficitur mi ex sit amet odio. Suspendisse egestas mi sit amet varius malesuada. Aliquam ac ex at quam pretium rutrum eu et metus. Phasellus vitae tortor lacinia, feugiat sapien id, porttitor arcu. Praesent efficitur sapien sed vestibulum dignissim. Donec ac arcu sed turpis posuere iaculis. Nam quis orci et diam molestie dictum. Pellentesque sed odio erat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ut molestie enim.

Page 2¶

Suspendisse vitae luctus purus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Mauris pretium placerat odio, id sollicitudin enim tincidunt ut. Proin libero mauris, porta eget enim ac, congue aliquam velit. Morbi volutpat consequat sapien, non egestas ipsum semper eu. Nulla a semper lacus, eget consequat magna. Aliquam rutrum vestibulum interdum. Donec ante arcu, congue nec tempor vitae, euismod nec est. Ut mattis nibh a ligula suscipit, sit amet placerat sapien imperdiet. Nam a sem orci. Proin libero quam, venenatis vel neque pellentesque, ullamcorper sagittis lorem. Curabitur feugiat accumsan magna, nec mattis lectus viverra eget. Donec laoreet, arcu a sodales sagittis, ligula ex tempus lectus, vitae scelerisque ligula ante vitae eros.

Page 3¶

Integer imperdiet lacus vel purus pellentesque egestas. Quisque rutrum velit et dui feugiat pellentesque. Proin tristique porta nibh, sit amet aliquam lorem consequat eget. Quisque finibus dui nisi, in ultrices quam varius at. Nullam et egestas odio. Sed libero tortor, accumsan sit amet fermentum at, consequat vel neque. Cras efficitur rutrum suscipit. Aenean id sollicitudin lorem, vel bibendum libero. Pellentesque quis tincidunt risus.

Donec pulvinar, lacus et fringilla tristique, lorem tellus aliquam dui, id tempor mauris erat a diam. Ut pulvinar risus non urna venenatis, sed eleifend orci finibus. Curabitur non congue purus. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Pellentesque tristique mattis ipsum, vel vestibulum ante placerat quis. Quisque dictum ut dui a varius. Morbi eget mauris euismod, tempor ex et, faucibus lectus. Integer lacus nisl, ultrices eget nunc a, tempor ultrices purus. Suspendisse dictum velit sed turpis pharetra, id finibus velit venenatis. Cras congue tortor ut condimentum rutrum. Vivamus vel mauris est.