Skip to content

Commit

Permalink
new docs setup
Browse files Browse the repository at this point in the history
  • Loading branch information
tumble1999 committed Feb 25, 2020
1 parent 21d5cab commit a71504a
Show file tree
Hide file tree
Showing 20 changed files with 2,826 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Dependency directories
node_modules/
jspm_packages/


# Optional npm cache directory
.npm

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

#bc reference
ref/


_build
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
5 changes: 5 additions & 0 deletions build-docs.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
@echo off
call npm i
call npm audit fix
call npm run docs
pause
Loading

0 comments on commit a71504a

Please sign in to comment.