Skip to content

Commit

Permalink
fix doc and add instructions, fix #23
Browse files Browse the repository at this point in the history
  • Loading branch information
boolangery committed Feb 11, 2023
1 parent b78f169 commit 0290f53
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 3 deletions.
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,14 @@ Will output:
}
}
}
Command line
==============================================================================

Documentation can be built with Sphinx:

.. code-block::
$ cd doc
$ pip install -r requirements.txt
$ make html
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python3.6 -msphinx
SPHINXBUILD = python3 -msphinx
SPHINXPROJ = luaparser
SOURCEDIR = source
BUILDDIR = build
Expand Down
3 changes: 3 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx
sphinx_rtd_theme
sphinxcontrib-napoleon
7 changes: 5 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -63,7 +66,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -93,7 +96,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down

0 comments on commit 0290f53

Please sign in to comment.