Skip to content

Commit

Permalink
Add structure for mkdocs instead of Sphinx (#225)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dref360 authored Oct 28, 2022
1 parent aa11074 commit 1fb6425
Show file tree
Hide file tree
Showing 80 changed files with 1,573 additions and 8,716 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img height=15% width=25% src="https://github.com/ElementAI/baal/blob/master/docs/_static/images/logo-transparent.png?raw=true">
<img height=15% width=25% src="https://github.com/ElementAI/baal/blob/master/docs/_static/images/logo-with-bg-solid.png?raw=true">
<h1 align="center">Bayesian Active Learning (Baal)
<br>
<a href="https://github.com/baal-org/baal/actions/workflows/pythonci.yml">
Expand Down Expand Up @@ -92,7 +92,7 @@ The framework consists of four main parts, as demonstrated in the flowchart belo
- ActiveLearningLoop

<p align="center">
<img src="./docs/literature/images/Baalscheme.svg">
<img src="docs/research/literature/images/Baalscheme.svg">
</p>

To get started, wrap your dataset in our _[**ActiveLearningDataset**](baal/active/dataset.py)_ class. This will ensure
Expand Down
21 changes: 4 additions & 17 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
# Minimal makefile for Sphinx documentation
# Minimal makefile for Mkdocs documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build


# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
build:
mkdocs build

server:
open _build/html/index.html
mkdocs watch
Loading

0 comments on commit 1fb6425

Please sign in to comment.