Skip to content

Commit

Permalink
Added notebooks docs support (#1592)
Browse files Browse the repository at this point in the history
Co-authored-by: Fedor Ignatov <ignatov.fedor@gmail.com>
  • Loading branch information
nastyachizhikova and IgnatovFedor committed Nov 5, 2022
1 parent 2bc186b commit a54b265
Show file tree
Hide file tree
Showing 15 changed files with 1,411 additions and 550 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Please leave us [your feedback](https://forms.gle/i64fowQmiVhMMC7f9) on how we c

**Models**

[Named Entity Recognition](http://docs.deeppavlov.ai/en/master/features/models/ner.html) | [Intent/Sentence Classification](http://docs.deeppavlov.ai/en/master/features/models/classifiers.html) |
[Named Entity Recognition](http://docs.deeppavlov.ai/en/master/features/models/NER.html) | [Intent/Sentence Classification](http://docs.deeppavlov.ai/en/master/features/models/classifiers.html) |

[Question Answering over Text (SQuAD)](http://docs.deeppavlov.ai/en/master/features/models/squad.html) | [Knowledge Base Question Answering](http://docs.deeppavlov.ai/en/master/features/models/kbqa.html)
[Question Answering over Text (SQuAD)](http://docs.deeppavlov.ai/en/master/features/models/SQuAD.html) | [Knowledge Base Question Answering](http://docs.deeppavlov.ai/en/master/features/models/kbqa.html)

[Sentence Similarity/Ranking](http://docs.deeppavlov.ai/en/master/features/models/neural_ranking.html) | [TF-IDF Ranking](http://docs.deeppavlov.ai/en/master/features/models/tfidf_ranking.html)

Expand Down
2 changes: 1 addition & 1 deletion deeppavlov/_meta.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '1.0.0rc1'
__version__ = '1.0.0'
__author__ = 'Neural Networks and Deep Learning lab, MIPT'
__description__ = 'An open source library for building end-to-end dialog systems and training chatbots.'
__keywords__ = ['NLP', 'NER', 'SQUAD', 'Intents', 'Chatbot']
Expand Down
16 changes: 16 additions & 0 deletions docs/_static/my_blocks.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
button.copybtn svg {
width: 1.3em;
height: 1.3em;
padding: 0.1em;
}

button.copybtn {
top: 0.2em;
width: 1.4em;
height: 1.4em;
}

.rst-content .linenodiv pre, .rst-content div[class^=highlight] pre, .rst-content pre.literal-block {
font-size: 13px;
line-height: 1.4;
}
31 changes: 21 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@
'sphinx.ext.mathjax',
'sphinx.ext.extlinks',
'nbsphinx',
'IPython.sphinxext.ipython_console_highlighting',
'sphinx_copybutton'
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -67,12 +69,16 @@
#
# 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.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
exclude_patterns = ['_build',
'Thumbs.db',
'.DS_Store',
'**.ipynb_checkpoints'
]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down Expand Up @@ -102,14 +108,7 @@
# 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_context = {
'css_files': [
'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
'_static/deeppavlov.css'
]
}
html_css_files = ['my_blocks.css', 'deeppavlov.css']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand All @@ -121,6 +120,18 @@
#
# html_sidebars = {}

nbsphinx_prolog = """
.. raw:: html
<style>
.nbinput .prompt,
.nboutput .prompt {
display: none;
}
</style>
"""
nbsphinx_execute = 'never'


# -- Options for HTMLHelp output ---------------------------------------------

Expand Down

0 comments on commit a54b265

Please sign in to comment.