Skip to content

Commit

Permalink
replace recommonmark with m2r
Browse files Browse the repository at this point in the history
blocked on miyakogi/m2r#16
  • Loading branch information
mrexodia committed Jun 11, 2018
1 parent 5b17ca8 commit 058ba20
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 22 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# docs

Documentation repository for [x64dbg](http://x64dbg.com) at [Read the Docs](https://readthedocs.org/projects/x64dbg).

## Building

1. `pip install sphinx recommonmark==0.4.0`
2. Add `relpath = relpath.replace(os.path.sep, '/')` to `C:\Python27\Lib\site-packages\recommonmark\transform.py` line `69`
3. run `makechm.bat`. It will build the .CHM help file.
# docs

Documentation repository for [x64dbg](http://x64dbg.com) at [Read the Docs](https://readthedocs.org/projects/x64dbg).

## Building

1. `pip install sphinx m2r sphinx_rtd_theme`
2. Add `relpath = relpath.replace(os.path.sep, '/')` to `C:\Python27\Lib\site-packages\recommonmark\transform.py` line `69`
3. run `makechm.bat`. It will build the .CHM help file.
15 changes: 2 additions & 13 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,12 @@
# ones.
extensions = [
'sphinx.ext.todo',
'm2r'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify

source_parsers = {
'.md': CommonMarkParser,
}

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
Expand Down Expand Up @@ -346,9 +340,4 @@
# texinfo_no_detailmenu = False

def setup(app):
app.add_config_value('recommonmark_config', {
'enable_auto_doc_ref': True,
'enable_inline_math': False,
'enable_auto_toc_tree': False
}, True)
app.add_transform(AutoStructify)
pass

0 comments on commit 058ba20

Please sign in to comment.