valitydev/osquery-1
14
0
Fork 0
mirror of https://github.com/valitydev/osquery-1.git synced 2024-11-06 01:25:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update .readthedocs.yml to use version 2 (#6456)

Browse Source
This commit is contained in:
Teddy Reed 2020-05-21 13:14:41 -04:00 committed by GitHub
parent c6f811b143
commit dec9a177e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.readthedocs.yml
View File

@ -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
README.md
View File

@ -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)

1
docs/requirements.txt Normal file
View File

@ -0,0 +1 @@
mkdocs==1.1.2

4
mkdocs.yml
View File

@ -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:
@ -9,7 +11,7 @@ extra_css:
markdown_extensions:
- admonition
pages:
nav:
- Introduction:
- Welcome to osquery: index.md
- osqueryi (shell): introduction/using-osqueryi.md