mirror of
https://github.com/marian-nmt/marian.git
synced 2024-09-10 22:05:58 +03:00
Upgrade dependencies in the documentation framework (#965)
* Upgrade lxml to 4.9.1; set docutils no higher than 0.17 * Remove mistune<2.0.3 due to potential vulnerability * Fix badges in docs * Update CHANGELOG
This commit is contained in:
parent
0afe2478aa
commit
347ab4d54a
@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|||||||
- Fixed check for `fortran_ordering` in cnpy
|
- Fixed check for `fortran_ordering` in cnpy
|
||||||
- Fixed fp16 training/inference with factors-combine concat method
|
- Fixed fp16 training/inference with factors-combine concat method
|
||||||
- Fixed clang 13.0.1 compatibility
|
- Fixed clang 13.0.1 compatibility
|
||||||
|
- Fixed potential vulnerabilities from lxml<4.9.1 or mistune<2.0.3
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Make guided-alignment faster via sparse memory layout, add alignment points for EOS, remove losses other than ce
|
- Make guided-alignment faster via sparse memory layout, add alignment points for EOS, remove losses other than ce
|
||||||
|
1
doc/.gitignore
vendored
1
doc/.gitignore
vendored
@ -2,3 +2,4 @@ api
|
|||||||
build
|
build
|
||||||
doxygen
|
doxygen
|
||||||
venv
|
venv
|
||||||
|
CONTRIBUTING.md
|
||||||
|
@ -14,10 +14,11 @@ help:
|
|||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
%: Makefile
|
%: Makefile
|
||||||
|
cp $(SOURCEDIR)/../CONTRIBUTING.md $(SOURCEDIR)/
|
||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
# Clean target as recommended by Exhale
|
# Clean target as recommended by Exhale
|
||||||
# https://exhale.readthedocs.io/en/latest/usage.html#optional-create-a-proper-clean-target
|
# https://exhale.readthedocs.io/en/latest/usage.html#optional-create-a-proper-clean-target
|
||||||
clean:
|
clean:
|
||||||
rm -rf doxygen/ api/
|
rm -rf doxygen/ api/ $(SOURCEDIR)/CONTRIBUTING.md
|
||||||
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
13
doc/conf.py
13
doc/conf.py
@ -114,16 +114,3 @@ exhale_args = {
|
|||||||
|
|
||||||
primary_domain = 'cpp'
|
primary_domain = 'cpp'
|
||||||
highlight_language = 'cpp'
|
highlight_language = 'cpp'
|
||||||
|
|
||||||
# A trick to include markdown files from outside the source directory using
|
|
||||||
# 'mdinclude'. Warning: all other markdown files not included via 'mdinclude'
|
|
||||||
# will be rendered using recommonmark as recommended by Sphinx
|
|
||||||
from m2r import MdInclude
|
|
||||||
|
|
||||||
def setup(app):
|
|
||||||
# from m2r to make `mdinclude` work
|
|
||||||
app.add_config_value('no_underscore_emphasis', False, 'env')
|
|
||||||
app.add_config_value('m2r_parse_relative_links', False, 'env')
|
|
||||||
app.add_config_value('m2r_anonymous_references', False, 'env')
|
|
||||||
app.add_config_value('m2r_disable_inline_math', False, 'env')
|
|
||||||
app.add_directive('mdinclude', MdInclude)
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
Welcome to Marian's documentation!
|
Welcome to Marian's documentation!
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
|buildgpu| |buildcpu| |tests| |release| |license|
|
|ubuntu| |windows| |macos| |release| |license|
|
||||||
|
|
||||||
Marian is an efficient and self-contained Neural Machine Translation framework with an integrated
|
Marian is an efficient and self-contained Neural Machine Translation framework with an integrated
|
||||||
automatic differentiation engine based on dynamic computation graphs, written entirely in C++.
|
automatic differentiation engine based on dynamic computation graphs, written entirely in C++.
|
||||||
@ -19,7 +19,7 @@ This is developer documentation. User documentation is available at https://mari
|
|||||||
factors
|
factors
|
||||||
api/library_index
|
api/library_index
|
||||||
|
|
||||||
contributing
|
CONTRIBUTING
|
||||||
|
|
||||||
doc_guide
|
doc_guide
|
||||||
|
|
||||||
@ -30,17 +30,17 @@ Indices and tables
|
|||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
|
|
||||||
|
|
||||||
.. |buildgpu| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/marian/job/marian-dev-cuda-10.2.svg?label=CUDAC%20Build
|
.. |ubuntu| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml/badge.svg
|
||||||
:target: http://vali.inf.ed.ac.uk/jenkins/job/marian-dev-cuda-10.2/
|
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml
|
||||||
:alt: GPU build status
|
:alt: Ubuntu build status
|
||||||
|
|
||||||
.. |buildcpu| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/marian/job/marian-dev-cpu.svg?label=CPU%20Build
|
.. |windows| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml/badge.svg
|
||||||
:target: http://vali.inf.ed.ac.uk/jenkins/job/marian-dev-cpu/
|
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml
|
||||||
:alt: CPU build status
|
:alt: Windows build status
|
||||||
|
|
||||||
.. |tests| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/marian/job/marian-regression-tests.svg?label=Tests
|
.. |macos| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml/badge.svg
|
||||||
:target: http://vali.inf.ed.ac.uk/jenkins/job/marian-regression-tests/
|
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml
|
||||||
:alt: Tests status
|
:alt: MacOS build status
|
||||||
|
|
||||||
.. |release| image:: https://img.shields.io/github/release/marian-nmt/marian.svg?label=Release
|
.. |release| image:: https://img.shields.io/github/release/marian-nmt/marian.svg?label=Release
|
||||||
:target: https://github.com/marian-nmt/marian/releases
|
:target: https://github.com/marian-nmt/marian/releases
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
|
lxml>=4.9.1
|
||||||
|
docutils<=0.17
|
||||||
sphinx==2.4.4
|
sphinx==2.4.4
|
||||||
breathe==4.13.0
|
breathe==4.13.0
|
||||||
exhale
|
exhale
|
||||||
sphinx_rtd_theme
|
sphinx_rtd_theme
|
||||||
myst-parser==0.14.0a3
|
myst-parser==0.14.0a3
|
||||||
mistune<2.0.0
|
|
||||||
m2r
|
|
||||||
sphinx-mathjax-offline
|
sphinx-mathjax-offline
|
||||||
Jinja2<3.1
|
Jinja2<3.1
|
||||||
|
Loading…
Reference in New Issue
Block a user