Skip to content

Commit

Permalink
fixup! [Docs] Add "Gramine features" (in Markdown)
Browse files Browse the repository at this point in the history
Adding the file to our ReadTheDocs and transforming emojis into unicode
characters.

Signed-off-by: Dmitrii Kuvaiskii <[email protected]>
  • Loading branch information
Dmitrii Kuvaiskii committed Mar 2, 2023
1 parent f69b68b commit 4a7e036
Show file tree
Hide file tree
Showing 6 changed files with 1,151 additions and 1,144 deletions.
2 changes: 1 addition & 1 deletion .ci/docs.jenkinsfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pipeline {
agent {
dockerfile { filename '.ci/ubuntu18.04.dockerfile' }
dockerfile { filename '.ci/ubuntu20.04.dockerfile' }
}
stages {
stage('build') {
Expand Down
1 change: 1 addition & 0 deletions .ci/ubuntu20.04.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ RUN python3 -m pip install -U \
'tomli>=1.1.0' \
'tomli-w>=0.4.0' \
'meson>=0.56,<0.57' \
'recommonmark' \
'docutils>=0.17,<0.18'

CMD ["bash"]
7 changes: 6 additions & 1 deletion Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@
import pathlib
import subprocess

import recommonmark.parser

# -- Project information -----------------------------------------------------

project = 'Gramine'
copyright = '2022, Gramine Contributors'
copyright = '2023, Gramine Contributors'
author = 'Gramine Contributors'

# The short X.Y version
Expand All @@ -42,6 +44,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
Expand All @@ -55,6 +58,8 @@
# The suffix(es) of source filenames.
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
'.markdown': 'markdown',
}

# The master toctree document.
Expand Down
Loading

0 comments on commit 4a7e036

Please sign in to comment.