Skip to content

Commit fa1b2ca

Browse files
committed
initial commit sphinx pages
1 parent 489f194 commit fa1b2ca

File tree

114 files changed

+21735
-0
lines changed

Some content is hidden

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

114 files changed

+21735
-0
lines changed

docs/.nojekyll

Whitespace-only changes.

docs/HOWTO.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Steps 1-4 are already done in the template! Start at step 5 :)
2+
3+
1. <DONE> Create a folder docs
4+
2. <DONE> By default, Jekyll does not build any files or directories with underscore. Include an empty .nojekyll file in the docs folder to turn off Jekyll.
5+
3. <DONE> In the docs folder, create an index.html file and redirect to ./html/index.html for example like this: <meta http-equiv="refresh" content="0; url=./html/index.html" />
6+
4. <DONE> Change the Sphinx build directory to docs in your Makefile for example as follows: BUILDDIR = pages
7+
8+
9+
TODO for every project seperately:
10+
11+
5. Go to your <repo_dir>/docs/
12+
6. Run <make clean>
13+
7. Run <make html>
14+
8. Repeat steps 6-7 until you are satisfied.
15+
16+
9. add, commit and push the repo.
17+
10. Go to your github settings: https://github.com/erdogant/bnlearn/settings
18+
a. Go to section: [GitHub Pages]
19+
b. Go to set [Source]
20+
c. Set to [master branch/docs folder]
21+
11. visit https://erdogant.github.io/<repo>
22+
23+
To create pdf run:
24+
12. sphinx-build -b pdf source build

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = pages
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+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman
160 KB
Loading
128 KB
Loading
57.8 KB
Loading
253 KB
Loading
214 KB
Loading
167 KB
Loading

0 commit comments

Comments
 (0)