Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically Generating Docs From Sphinx #235

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Empty file removed docs/.nojekyll
Empty file.
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
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)
22 changes: 22 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Setup to Generate Docs From Docstrings

1. Install sphinx
```
pip install Sphinx
```
2. Install Theme
```
pip install sphinx-rtd-theme
```
3. Move to docs folder
```
cd docs
```
4. Update docs if needed (OPTIONAL)
```
sphinx-apidoc -o . ../evalai
```
5. Generate HTML Using Provided theme
```
make html
```
Binary file not shown.
68 changes: 0 additions & 68 deletions docs/assets/active.js

This file was deleted.

6 changes: 0 additions & 6 deletions docs/assets/bootstrap.min.css

This file was deleted.

7 changes: 0 additions & 7 deletions docs/assets/bootstrap.min.js

This file was deleted.

224 changes: 0 additions & 224 deletions docs/assets/css

This file was deleted.