Skip to content

Commit

Permalink
docs: Update .readthedocs.yml to use version 2 (#6456)
Browse files Browse the repository at this point in the history
  • Loading branch information
Teddy Reed authored May 21, 2020
1 parent c6f811b commit dec9a17
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2

# We run out of memory on the RTD builder.
submodules:
exclude: all

mkdocs:
configuration: mkdocs.yml

python:
version: 3.7
install:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Available for Linux, macOS, Windows, and FreeBSD.
- Table Schema: https://osquery.io/schema
- Query Packs: [https://osquery.io/packs](https://github.com/facebook/osquery/tree/master/packs)
- Slack: [![Slack Status](https://osquery-slack.herokuapp.com/badge.svg)](https://osquery-slack.herokuapp.com)
- Build Status: [![Build Status](https://dev.azure.com/trailofbits/osquery/_apis/build/status/osquery?branchName=master)](https://dev.azure.com/trailofbits/osquery/_build/latest?definitionId=6&branchName=master) [![Coverity Scan Build Status](https://scan.coverity.com/projects/13317/badge.svg)](https://scan.coverity.com/projects/osquery)
- Build Status: [![Build Status](https://dev.azure.com/trailofbits/osquery/_apis/build/status/osquery?branchName=master)](https://dev.azure.com/trailofbits/osquery/_build/latest?definitionId=6&branchName=master) [![Coverity Scan Build Status](https://scan.coverity.com/projects/13317/badge.svg)](https://scan.coverity.com/projects/osquery) [![Documentation Status](https://readthedocs.org/projects/osquery/badge/?version=latest)](https://osquery.readthedocs.io/en/latest/?badge=latest)
- CII Best Practices: [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3125/badge)](https://bestpractices.coreinfrastructure.org/projects/3125)


Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs==1.1.2
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
site_name: osquery
theme: readthedocs

repo_url: https://github.com/osquery/osquery
edit_uri: https://github.com/osquery/osquery/edit/master/docs/wiki/
docs_dir: docs/wiki
site_dir: build/wiki
extra_css:
Expand All @@ -9,7 +11,7 @@ extra_css:
markdown_extensions:
- admonition

pages:
nav:
- Introduction:
- Welcome to osquery: index.md
- osqueryi (shell): introduction/using-osqueryi.md
Expand Down

0 comments on commit dec9a17

Please sign in to comment.