Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new doc

Browse Source
This commit is contained in:
tqchen 2015-08-01 21:36:09 -07:00
parent 387339bf17
commit 44b60490f4
2 changed files with 18 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/guide.md
View File

@ -352,7 +352,7 @@ Rabit is a portable library that can run on multiple platforms.
#### Customize Tracker Script #### Customize Tracker Script
You can also modify the tracker script to allow rabit to run on other platforms. To do so, refer to existing You can also modify the tracker script to allow rabit to run on other platforms. To do so, refer to existing
tracker scripts, such as [../tracker/rabit_hadoop.py](../tracker/rabit_hadoop.py) and [../tracker/rabit_mpi.py](https://github.com/dmlc/rabit/blob/master/tracker/rabit_mpi.py) to get a sense of how it is done. tracker scripts, such as [../tracker/rabit_yarn.py](../tracker/rabit_yarn.py) and [../tracker/rabit_mpi.py](https://github.com/dmlc/rabit/blob/master/tracker/rabit_mpi.py) to get a sense of how it is done.
You will need to implement a platform dependent submission function with the following definition You will need to implement a platform dependent submission function with the following definition
```python ```python

44
doc/sphinx_util.py
View File

@ -2,6 +2,7 @@
"""Helper utilty function for customization.""" """Helper utilty function for customization."""
import sys import sys
import os import os
import docutils
import subprocess import subprocess
if os.environ.get('READTHEDOCS', None) == 'True': if os.environ.get('READTHEDOCS', None) == 'True':
@ -10,37 +11,26 @@ if os.environ.get('READTHEDOCS', None) == 'True':
'mv recommonmark/recommonmark recom', shell=True) 'mv recommonmark/recommonmark recom', shell=True)
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
from recom import parser from recom import parser, transform
class MarkdownParser(parser.CommonMarkParser): class MarkdownParser(docutils.parsers.Parser):
github_doc_root = None github_doc_root = None
doc_suffix = set(['md', 'rst'])
@staticmethod
def remap_url(url):
if MarkdownParser.github_doc_root is None or url is None:
return url
if url.startswith('#'):
return url
arr = url.split('#', 1)
ssuffix = arr[0].rsplit('.', 1)
if len(ssuffix) == 2 and (ssuffix[-1] in MarkdownParser.doc_suffix def __init__(self):
and arr[0].find('://') == -1): self.parser = parser.CommonMarkParser()
arr[0] = arr[0][:-3] + '.html'
return '#'.join(arr)
else:
return MarkdownParser.github_doc_root + url
def reference(self, block): def parse(self, inputstring, document):
block.destination = remap_url(block.destination) self.parser.parse(inputstring, document)
return super(MarkdownParser, self).reference(block) transform.AutoStructify.url_resolver = [resolve_url]
for trans in self.get_transforms():
transform.AutoStructify(document).apply()
# inplace modify the function in recommonmark module to allow link remap def get_transforms(self):
old_ref = parser.reference return [transform.AutoStructify]
def reference(block): def resolve_url(url):
block.destination = MarkdownParser.remap_url(block.destination) if MarkdownParser.github_doc_root is None or url is None:
return old_ref(block) return url
else:
parser.reference = reference return MarkdownParser.github_doc_root + url