Skip to content
Mykola Malkov edited this page Apr 23, 2018 · 5 revisions

Welcome to the ursa_doc wiki!

Here are documentation of URSA (Universal Role-play System Advanced https://ursa.blogspot.com/) and build tools for it.

reStructuredText format http://docutils.sourceforge.net/rst.html is used for documentation.

For html building Sphinx http://www.sphinx-doc.org/en/1.4.8/ is used.

In order to make changes edit documentation/blog_*.rst file using correct rst markdown. A new file has to be located in documentation e, have 'blog_' prefix and snake_case style name which will be the name of the page on blog.

Add a new file to index.rst file.

To build html files run 'make clean ; make html' they will be located in _build/html/documentation directory.

To update pages on blog with new html files run './blogger.pl'. A new browser tab will be opened to process authorization. Then it will be redirected to http://localhost:8080 which likely will be unavailible but with "code=" parameter in address line. Copy code between "code=4/" and final "#" and paste it to console where blogger.pl is waiting 'Process authorization and paste code here'. After that 1 hour token will be printed and files will be uploaded to blog. For the next runs token can be passed to blogger.pl via option -t to skip authorization part.

There is a bug in Blogger API so a new page can't be created via API so if you add a new page - you need to create empty page with title: <name of file> beforehand on WI of Blogger.

Clone this wiki locally