SECTION 1: Introduction¶
Congratulations! If you can see this file you have probably successfully run the
runestone init command. If you are looking at this as a source file you should now run
runestone build to generate html files. Once you have run the build command you can run
runestone serve and then view this in your browser at
This is just a sample of what you can do. The index.rst file is the table of contents for your entire project. You can put all of your writing in the index, or you can include additional rst files. Those files may even be in subdirectories that you can reference using a relative path.
SECTION 3: Sample Directives¶
These are just two of the many interactive components for writing online course materials. You can see examples of all of them On our Example Page
Now feel free to modify this file to start creating your own interactive page.
Section 4: Theme¶
You can override the style rules in the default theme by adding css rules to a file named theme-overrides.css (the filename is important - this will replace an existing file). Make sure the file’s directory is part of the
html_static_path. You can do so by placing it in a folder _static, then modifying
html_static_path in conf.py to include that folder:
html_static_path = runestone_static_dirs() + ['_static']
If you want to do more significant changes to the theme, you should copy the files in the runestone/common/project/template/sphinx_bootstrap to a directory like
_templates/my_theme. Then make sure these values are set in conf.py:
html_theme_path = ["_templates"] html_theme = 'my_theme'