Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
Fairseq
Commits
4a47b889
Commit
4a47b889
authored
Sep 03, 2018
by
Myle Ott
Browse files
Update documentation
parent
6381cc97
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
3 additions
and
82 deletions
+3
-82
docs/conf.py
docs/conf.py
+1
-82
docs/requirements.txt
docs/requirements.txt
+2
-0
No files found.
docs/conf.py
View file @
4a47b889
...
@@ -20,20 +20,10 @@
...
@@ -20,20 +20,10 @@
import
os
import
os
import
sys
import
sys
import
fairseq
import
sphinx_rtd_theme
# source code directory, relative to this file, for sphinx-autobuild
# source code directory, relative to this file, for sphinx-autobuild
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'..'
))
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'..'
))
import
recommonmark
from
recommonmark.parser
import
CommonMarkParser
from
recommonmark.transform
import
AutoStructify
source_parsers
=
{
'.md'
:
CommonMarkParser
}
source_suffix
=
[
'.rst'
,
'.md'
]
source_suffix
=
[
'.rst'
]
# -- General configuration ------------------------------------------------
# -- General configuration ------------------------------------------------
...
@@ -47,9 +37,7 @@ source_suffix = ['.rst', '.md']
...
@@ -47,9 +37,7 @@ source_suffix = ['.rst', '.md']
extensions
=
[
extensions
=
[
'sphinx.ext.autodoc'
,
'sphinx.ext.autodoc'
,
'sphinx.ext.intersphinx'
,
'sphinx.ext.intersphinx'
,
'sphinx.ext.mathjax'
,
'sphinx.ext.viewcode'
,
'sphinx.ext.viewcode'
,
'sphinx.ext.githubpages'
,
'sphinx.ext.napoleon'
,
'sphinx.ext.napoleon'
,
'sphinxarg.ext'
,
'sphinxarg.ext'
,
]
]
...
@@ -102,7 +90,6 @@ todo_include_todos = False
...
@@ -102,7 +90,6 @@ todo_include_todos = False
# a list of builtin themes.
# a list of builtin themes.
#
#
html_theme
=
'sphinx_rtd_theme'
html_theme
=
'sphinx_rtd_theme'
html_theme_path
=
[
sphinx_rtd_theme
.
get_html_theme_path
()]
# Theme options are theme-specific and customize the look and feel of a theme
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# further. For a list of options available for each theme, see the
...
@@ -143,71 +130,3 @@ intersphinx_mapping = {
...
@@ -143,71 +130,3 @@ intersphinx_mapping = {
'python'
:
(
'https://docs.python.org/'
,
None
),
'python'
:
(
'https://docs.python.org/'
,
None
),
'torch'
:
(
'https://pytorch.org/docs/master/'
,
None
),
'torch'
:
(
'https://pytorch.org/docs/master/'
,
None
),
}
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename
=
'fairseqdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements
=
{
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents
=
[
(
master_doc
,
'fairseq.tex'
,
'fairseq Documentation'
,
'Facebook AI Research (FAIR)'
,
'manual'
),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages
=
[
(
master_doc
,
'fairseq'
,
'fairseq Documentation'
,
[
author
],
1
)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents
=
[
(
master_doc
,
'fairseq'
,
'fairseq Documentation'
,
author
,
'fairseq'
,
'One line description of project.'
,
'Miscellaneous'
),
]
# app setup hook
def
setup
(
app
):
app
.
add_config_value
(
'recommonmark_config'
,
{
'url_resolver'
:
lambda
url
:
github_doc_root
+
url
,
'auto_toc_tree_section'
:
'Contents'
,
'enable_eval_rst'
:
True
,
'enable_auto_doc_ref'
:
True
,
},
True
)
app
.
add_transform
(
AutoStructify
)
docs/requirements.txt
0 → 100644
View file @
4a47b889
sphinx<2.0
sphinx-argparse
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment