Skip to content

Commit

Permalink
fixing remaining issues with new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ncilfone committed Dec 14, 2021
1 parent 844409f commit 07bc2d3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
10 changes: 8 additions & 2 deletions website/docs/api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: API Reference
title: Spock API Reference
sidebar_position: 1
---

Landing page
`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`.
3 changes: 2 additions & 1 deletion website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
},
{
label: 'Quick Start',
to: '/docs/quick-start',
to: 'Quick-Start',
},
{
label: 'Examples',
Expand Down
2 changes: 1 addition & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ module.exports = {
'api',
{
type: 'category',
label: 'spock-api',
label: 'Python API',
items: [
{
type: 'autogenerated',
Expand Down

0 comments on commit 07bc2d3

Please sign in to comment.