marian-nmt/marian
1
1
Fork 0
mirror of https://github.com/marian-nmt/marian.git synced 2024-11-04 14:04:24 +03:00
Code Issues Packages Projects Releases Wiki Activity
b6581c4c44
marian/doc/index.rst

52 lines
1.5 KiB
ReStructuredText
Raw Normal View History

Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
Welcome to Marian's documentation!
==================================
Merged PR 25919: Sync with public master - no review required Sync with public master, checking compilation, regression tests etc.
2022-10-04 03:42:52 +03:00
|ubuntu| |windows| |macos| |release| |license|
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
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++.
This is developer documentation. User documentation is available at https://marian-nmt.github.io/docs/
.. toctree::
:maxdepth: 2
:caption: Contents:
Document Structure (#910) * Add architectural outline * Update index
2022-02-08 13:58:09 +03:00
structure
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
graph
operators
Layer documentation (#892) * More examples for MLP layers and docs about RNN layers * Docs about embedding layer and more doxygen code docs * Add layer and factors docs into index.rst * Update layer documentation * Fix typos Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com> Co-authored-by: Graeme Nail <graemenail.work@gmail.com>
2022-01-26 18:17:38 +03:00
layer
factors
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
api/library_index
Merged PR 25919: Sync with public master - no review required Sync with public master, checking compilation, regression tests etc.
2022-10-04 03:42:52 +03:00
CONTRIBUTING
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
Documentation about how to write code documentation (#891) * add initial guidelines of code documentation * fix math formula not displayed in Sphinx * remove @name tags which cannot be extracted by exhale and cause function signature errors * fix markdown ref warning and update markdown parser in sphinx * more about doxygen: add Doxygen commands and math formulas * move code doc guide to a new .rst file * add formula image * Set myst-parser version appropriate for the requested sphinx version * Update documentation on how to write Doxygen comments * Add new section to the documentation index * Sphinx 2.4.4 requires myst-parser 0.14 * complete code doc guide and small fixes on reStructuredText formats * More about reStructuredText * Update badges on the documentation frontpage Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com>
2021-12-07 18:10:46 +03:00
doc_guide
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
Indices and tables
------------------
* :ref:`genindex`
Merged PR 25919: Sync with public master - no review required Sync with public master, checking compilation, regression tests etc.
2022-10-04 03:42:52 +03:00
.. |ubuntu| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml
:alt: Ubuntu build status
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
Merged PR 25919: Sync with public master - no review required Sync with public master, checking compilation, regression tests etc.
2022-10-04 03:42:52 +03:00
.. |windows| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml
:alt: Windows build status
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
Merged PR 25919: Sync with public master - no review required Sync with public master, checking compilation, regression tests etc.
2022-10-04 03:42:52 +03:00
.. |macos| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml
:alt: MacOS build status
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) * Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2021-02-23 19:25:30 +03:00
.. |release| image:: https://img.shields.io/github/release/marian-nmt/marian.svg?label=Release
:target: https://github.com/marian-nmt/marian/releases
:alt: Latest release
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: ../LICENSE.md
:alt: License: MIT
Reference in New Issue Copy Permalink