Switch doc theme to Furo

This commit is contained in:
Reuben Morais 2021-03-19 10:25:42 +01:00
parent 6b9de13ad1
commit b4e8802aff
3 changed files with 12 additions and 19 deletions

View File

@ -1,12 +1,12 @@
Java API Usage example
======================
Examples are from `native_client/java/app/src/main/java/ai/coqui/STTActivity.java`.
Examples are from `native_client/java/app/src/main/java/ai/coqui/sttexampleapp/STTActivity.java`.
Creating a model instance and loading model
-------------------------------------------
.. literalinclude:: ../native_client/java/app/src/main/java/ai/coqui/STTActivity.java
.. literalinclude:: ../native_client/java/app/src/main/java/ai/coqui/sttexampleapp/STTActivity.java
:language: java
:linenos:
:lineno-match:
@ -16,7 +16,7 @@ Creating a model instance and loading model
Deploying trained model
--------------------
.. literalinclude:: ../native_client/java/app/src/main/java/ai/coqui/STTActivity.java
.. literalinclude:: ../native_client/java/app/src/main/java/ai/coqui/sttexampleapp/STTActivity.java
:language: java
:linenos:
:lineno-match:
@ -26,4 +26,4 @@ Deploying trained model
Full source code
----------------
See :download:`Full source code<../native_client/java/app/src/main/java/ai/coqui/STTActivity.java>`.
See :download:`Full source code<../native_client/java/app/src/main/java/ai/coqui/sttexampleapp/STTActivity.java>`.

View File

@ -74,8 +74,8 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx_rtd_theme',
'sphinx_js',
'sphinx_csharp',
'breathe'
]
@ -128,15 +128,7 @@ add_module_names = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_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
# documentation.
#
html_theme_options = {
'collapse_navigation': False,
}
html_theme = 'furo'
# 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,

View File

@ -1,7 +1,8 @@
breathe==4.14.2
breathe==4.27.0
semver==2.8.1
sphinx==2.4.4
#FIXME: switch back to upstream sphinx-js when https://github.com/mozilla/sphinx-js/pull/135 is merged or the issue is fixed otherwise
git+git://github.com/reuben/sphinx-js.git@a24775935443d21028ee4a7025a407c78030c4e7#egg=sphinx-js
sphinx-rtd-theme==0.4.3
sphinx==3.5.2
sphinx-js==3.1
furo==2021.2.28b28
pygments==2.6.1
#FIXME: switch to stable after C# changes have been merged: https://github.com/djungelorm/sphinx-csharp/pull/8
git+https://github.com/rogerbarton/sphinx-csharp.git