Using runestone with existing sphinx project

[Senthil Kumaran]

I followed the instructions given here

https://github.com/RunestoneInteractive/RunestoneComponents#notes-for-more-advanced-users 

to use RuneStone directly with an existing sphinx project of mine

https://github.com/orsenthil/coursedocs 

I used the activecode directive and in a simple example .rst file and tried to build it. It resulted in this error.

Exception occurred:

  File "/Users/senthil/py/virtualenvironments/sphinx-runestone/lib/python2.7/site-packages/runestone/activecode/activecode.py", line 350, in run

    course_name = env.config.html_context['course_id']

KeyError: 'course_id'

I see that in the runestone setup itself, this is populated via paver, how do we give this variable in sphinx?

Is using runestone components directly with sphinx a good idea? OR would I be better off to use runestone as documented and port my _static .rst files to the runestone created directory?

Thanks in advance.

Senthil

[Brad Miller]

In looking at the error message, you are definitely missing a few template variables including the course_id variable.  A sphinx-build looks like this for a typical project:

sphinx-build -b html -d ././build/fopp/doctrees -c . -Acourse_id=fopp -Alogin_required=false -Aappname=runestone -Aloglevel=10 -Acourse_url=http://127.0.0.1:8000 -Ause_services=true -Apython3=true -Adburl=postgresql://bradleymiller:@localhost/bmiller -Adefault_ac_lang=python -Abasecourse=fopp -Adownloads_enabled=false -Aenable_chatcodes=false -Arunestone_version=3.2.0 -Abuild_info=unknown ./_sources ./build/fopp

I believe you could add many of the -Axxxx variables to your current Makefile using the SPHINXOPTS variable.  Or if you plan to incorporate a lot of the runestone components into your project you may find the runestone command (with accompanying pavement.py) file will work more easily.

Brad

--
You received this message because you are subscribed to the Google Groups "RunestoneInteractive" group.
To unsubscribe from this group and stop receiving emails from it, send an email to runestoneinterac...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Senthil Kumaran]

Hello Brad,

Thanks for the reponse.

I got it to build.  

https://www.dropbox.com/s/b8yqdu5yp4rw74a/Screenshot%202018-08-21%2018.40.53.png?dl=0 

I am assuming in order to really use the features of runstone like .. activecode:: and ..mchoice:: directives, I will need to have the database backend. Is that correct?

pip install runestone in your sphinx project is not really a sphinx extension to include ..activecode:: ..mchoice:: and other components that runestone provides. If we want to use it, we have to use runestone entirely, including setting up the server. Is that correct?

Thank you,

Senthil

To unsubscribe from this group and stop receiving emails from it, send an email to runestoneinteractive+unsub...@googlegroups.com.

[Brad Miller]

Glad you got it to build.

You do not need the runestone server or the database in order to build a fully functioning book with all of the different components.  You can build the book and host it as a static website on any server.  That is why runestone init gives you the option to use runestone services or not.

However, without using runestone services on the backend then your students will not be able to save their work, and you will not be able to use the assignment and grading features or be able to track their progress.

Brad

To unsubscribe from this group and stop receiving emails from it, send an email to runestoneinterac...@googlegroups.com.