Skip to content

Commit 575b580

Browse files
ftian1deb-intel
andauthored
Doc updates for online website creation (intel#5)
Signed-off-by: Deb Taylor <deb.taylor@intel.com> Reviewed-by: Feng Tian <feng.tian@intel.com> Co-authored-by: Deb Taylor <deb.taylor@intel.com>
1 parent 0dc79ef commit 575b580

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1764
-771
lines changed

.github/workflows/publish.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Publish
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
build:
10+
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v1
15+
- name: Install dependencies
16+
run: |
17+
export PATH="$HOME/.local/bin:$PATH"
18+
sudo apt-get install -y python3-setuptools
19+
pip3 install --user -r sphinx-requirements.txt
20+
- name: Build the docs
21+
run: |
22+
export PATH="$HOME/.local/bin:$PATH"
23+
make html
24+
- name: Push the docs
25+
uses: peaceiris/actions-gh-pages@v3
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: _build/html
29+
publish_branch: latestHTML

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
*.log
1010
*.swp
1111
*.onnx
12+
_build

CONTRIBUTING.md

-38
This file was deleted.

Makefile

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = ProjectnameIntelLowPrecisionOptimizationTool
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
18+
html:
19+
$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
20+
cp _static/index.html $(BUILDDIR)/html/index.html
21+
mkdir "$(BUILDDIR)/html/docs/imgs"
22+
cp docs/imgs/infrastructure.png "$(BUILDDIR)/html/docs/imgs/infrastructure.png"
23+
cp docs/imgs/workflow.png "$(BUILDDIR)/html/docs/imgs/workflow.png"
24+
25+
26+
# Catch-all target: route all unknown targets to Sphinx using the new
27+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
28+
%: Makefile
29+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 commit comments

Comments
 (0)