Sphinx Instructions

[suzannastep]

In the section on Sphinx, it says,
"So open up your master file (emacs is installed in the docker container) located at docs/index.rst. For now we'll simply add a single code block to the master file right after it has:"

I'm running docker and I'm /lattices_repo/docs directory within the container, but I don't understand how to edit the index.rst file. I'm guessing emacs is a text editor, but how do I use it to open and edit the file?

Thanks, Sue

[wsmorgan]

From your terminal type emacs index.rst this will open the emacs text editor and allow you to edit the file. When your done use Ctrl-x Ctrl-s to save and Ctrl-x Ctrl-c to close (you can just hold control down and push x then s or x then c for the two). You can choose to use any other text editor that exists on the docker as well, I believe it should include nano and anything else a native linux machine would.

[suzannastep]

Now Sphinx makes the html file, but the website is still empty when I go to it

Suzannas-MBP:docs SuzannaStephenson$ make html
Running Sphinx v1.6.6
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index
/Users/SuzannaStephensonAdmin/Documents/Research/LatticesResearch/lattices_repo/docs/index.rst:13: WARNING: autodoc: failed to import module 'lattices_pkg.trial'; the following exception was raised:
Traceback (most recent call last):
File "/anaconda3/lib/python3.6/site-packages/sphinx/ext/autodoc.py", line 658, in import_object
import(self.modname)
ModuleNotFoundError: No module named 'lattices_pkg'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

Build finished. The HTML pages are in _build/html.

[wsmorgan]

Looking at your package and your index.rst the problem is that:

.. automodule : :  lattices_repo.trial
   :members:

should be:

.. automodule : :  lattices_pkg.trial
   :members:

Try that and see if it fixes anything.

[suzannastep]

Now it says the same thing but,

ModuleNotFoundError: No module named 'lattices_repo'

instead of ModuleNotFoundError: No module named 'lattices_pkg'

[wsmorgan]

.. automodule : : should be .. automodule :: with no spaces between the colons. Also if lattices_pkg is in your index.rst I'm confused as to why it's complaining about lattices_repo. Still try removing the extra space and lets see what happens.