OpenSesame documentation area

Copyright 2010-2024

Sebastiaan Mathôt [email protected]

About

This repository contains the source for http://osdoc.cogsci.nl/.

Format

All files are formatted with Markdown syntax, supplemented with academicmarkdown.

Style

• Write item types in uppercase: SKETCHPAD (This is automatically parsed and styled.)
• Write item names in italics: *new_sketchpad*
• Write backend names in italics: *psycho*
• Do not hyphenate 'backend' or 'plugin'
• Capitalize 'Run phase' and 'Prepare phase'

Important files and folders

• sitemap.yaml contains the site structure used to generate the menu.
• versions.yml contains a description of all branches of the documentation. Each branch corresponds to a different documentation site, and lives in a different git branch of the repository.
• content/pages/ contains the site content.

Site generation

To generate the site for local testing:

python3 build-menu.py # optional, to regenerate the menu
python3 build-api.py # optional, to regenerate the Python api
pelican -s pelicanconf.py

Or, to generate the site for publication, run:

python3 build-menu.py --publish
python3 build-api.py # optional, to regenerate the Python api
pelican -s publishconf.py

This will generate the site in the folder output.

Previewing

Once the site has been generated, open a terminal in the output folder and start a basic webserver to view it:

python -m http.server

You can now visit http://localhost:8000 in a browser to view the site, which will be in a subfolder, e.g. http://localhost:8000/3.1

Dependencies

• pelican
• inkscape (used for converting svg to png)
• jinja2
• python-academicmarkdown
• python-yamldoc

License information

OpenSesame documentation area by Sebastiaan Mathôt is licensed under a Creative Commons Attribution 3.0 Unported License.
Based on a work at https://github.com/smathot/osdoc.