From 07bc2d3d248bdbf80268b2b6896dc9b8734c8f5e Mon Sep 17 00:00:00 2001 From: Nicholas Cilfone Date: Tue, 14 Dec 2021 14:46:06 -0500 Subject: [PATCH] fixing remaining issues with new docs --- website/docs/api.md | 10 ++++++++-- website/docs/index.md | 3 ++- website/docusaurus.config.js | 2 +- website/sidebars.js | 2 +- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/website/docs/api.md b/website/docs/api.md index 4c8065da..c47d4a54 100644 --- a/website/docs/api.md +++ b/website/docs/api.md @@ -1,6 +1,12 @@ --- -title: API Reference +title: Spock API Reference sidebar_position: 1 --- -Landing page \ No newline at end of file +`spock` is a framework that helps manage complex parameter configurations during research and development of Python +applications. `spock` lets you focus on the code you need to write instead of re-implementing boilerplate code like +creating ArgParsers, reading configuration files, implementing traceability etc. + + +These pages contain the Python API reference of `spock` including both public and private methods/classes, etc. Please +refer to [Quick Start](Quick-Start.md) for getting started with `spock`. \ No newline at end of file diff --git a/website/docs/index.md b/website/docs/index.md index 4f5a0340..4ed3e6c5 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -73,8 +73,9 @@ Example `spock` usage is located [here](https://github.com/fidelity/spock/blob/m See [Releases](https://github.com/fidelity/spock/releases) for more information. -#### December 13, 2021 +#### December 14, 2021 * Refactored the backend to better handle nested dependencies (and for clarity) +* Refactored the docs to use Docusaurus #### August 17, 2021 * Added hyper-parameter tuning backend support for Ax via Service API diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0b8fc746..8169828a 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -76,7 +76,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); }, { label: 'Quick Start', - to: '/docs/quick-start', + to: 'Quick-Start', }, { label: 'Examples', diff --git a/website/sidebars.js b/website/sidebars.js index c440b360..e1d04c88 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -163,7 +163,7 @@ module.exports = { 'api', { type: 'category', - label: 'spock-api', + label: 'Python API', items: [ { type: 'autogenerated',