Skip to content

Commit

Permalink
Add link to Developer API; small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
snukky committed Jan 25, 2022
1 parent bdce02d commit e7e8943
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 17 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ install: Gemfile
update-gems: Gemfile
bundle update

## Updte pages with command-line options
## Update pages with command-line options
update-cmds: $(CMDFILES)

## Update verion datafile
Expand Down Expand Up @@ -62,7 +62,6 @@ $(MARIAN):
&& cmake .. -DCOMPILE_SERVER=ON \
&& make -j8


# Clean
clean:
bundle exec jekyll clean
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The website is build with Jekyll - a static site generator.
The content is created and updated on branch `jekyll`, then the static pages
are generated with Jekyll and stored in the branch `master`.

Please **do not update files directly in `master`**.
:warning: Please **do not update files directly in `master`**. :warning:

## Automated build

Expand All @@ -20,7 +20,7 @@ This covers:
The CLI and API document content is determined by the pinned version of the
marian-dev submodule.

The CLI documentation
### The CLI documentation

This pipeline is triggered by pushes on the source branch `jekyll`, and, on
success, the resulting site is pushed to the GitHub pages branch (`master`).
Expand All @@ -31,7 +31,6 @@ pushed onto the source branch (message: `Update CLI options:`).
This is necessary due to the renderedtimestamp of these files being
determined from their last-commit date.
-->

For pull requests against the source branch, the resulting site is available as
an artifact and should be reviewed before approval.

Expand Down
8 changes: 4 additions & 4 deletions _data/cards.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
link: faq
icon: fa-life-ring
color: blue
- title: Blog
intro: Blog post for when we feel creative
link: blog
icon: fa-pencil
- title: Developer API
intro: Developer documentation and library API
link: docs/api
icon: fa-code-fork
color: orange
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ for [previous releases]({% link docs/cmd/index.md %}).



### Code documentation

[The developer documentation for Marian]({{ 'docs/api/' | relative_url }}) is generated using Doxygen
and Sphinx. It can be generated locally from the {% github_link marian-dev/doc/
%} folder.



### Model types

- `s2s`: An RNN-based encoder-decoder model with attention mechanism. The
Expand All @@ -70,6 +62,14 @@ and Sphinx. It can be generated locally from the {% github_link marian-dev/doc/



### Developer API

[The developer documentation for Marian]({{ 'docs/api/' | relative_url }}) is
generated using Doxygen and Sphinx. The newest version can be generated locally
from the {% github_link marian-dev/doc/ %} folder.



## Installation

Clone a fresh copy from github:
Expand Down

0 comments on commit e7e8943

Please sign in to comment.