diff --git a/docs/index.md b/docs/index.md index 906acb5f9..04f919d19 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ site_name: bqplot site_description: bqplot: 2-D interactive visualization system for the Jupyter notebook -site_url: https://bqplot.github.io/ +site_url: https://bqplot.github.io/bqplot # bqplot diff --git a/docs/installation.md b/docs/installation.md index 575fd7145..f03e794b0 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -112,10 +112,6 @@ Versions lookup table: | 0.11.1 | 0.4.1 | | 0.11.0 | 0.4.0 | -### Contributing To `bqplot` - -See our [contributing guidelines](contributing.md) to know how to contribute and set up a development environment. - ### License This software is licensed under the Apache 2.0 license. See the [LICENSE](LICENSE) file diff --git a/docs/usage/figure.md b/docs/usage/figure.md index 324fef906..2e9239e06 100644 --- a/docs/usage/figure.md +++ b/docs/usage/figure.md @@ -2,8 +2,8 @@ `Figure` API documentation can be accessed using the following links: -1. [Figure](bqplot/api/figure) class -2. [`figure`](bqplot/api/pyplot/#bqplot.pyplot.figure) method in `pyplot` +1. [Figure](../api/figure.md) class +2. [`figure`](../api/pyplot.md#bqplot.pyplot.figure) method in `pyplot` In this section, we'll be focusing on pyplot API to create and configure `figure` objects. @@ -17,9 +17,9 @@ fig = plt.figure() ### Attributes -#### [Style Attributes](bqplot/api/figure/#bqplot.Figure--style-attributes) +#### [Style Attributes](../api/figure.md#bqplot.Figure--style-attributes) Style attributes can be used for styling the figure (title, backgrounds, legends) etc. -#### [Layout Attributes](bqplot/api/figure/#bqplot.Figure--layout-attributes) +#### [Layout Attributes](../api/figure.md#bqplot.Figure--layout-attributes) Layout attributes can be used for controlling the dimensions and margins ### Code Examples @@ -70,7 +70,5 @@ fig As you can see in the image above the grey region is the figure margin. - - #### Interactions Refer to the [Interaction](interactions/index.md) document for more details diff --git a/mkdocs.yml b/mkdocs.yml index 278e611c3..5bb1370d5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,20 +5,20 @@ repo_url: https://github.com/bqplot/bqplot theme: name: material custom_dir: custom_theme/ - logo: https://raw.githubusercontent.com/bqplot/design/master/bqplot-logo-dark-notext-nobackground.svg + logo: https://raw.githubusercontent.com/bqplot/design/master/bqplot-logo-notext-nobackground.svg favicon: https://raw.githubusercontent.com/bqplot/design/master/bqplot-logo-notext-nobackground.svg extra: homepage: https://bqplot.github.io/bqplot palette: - scheme: default - primary: black - accent: black + primary: red + accent: red toggle: icon: material/brightness-7 name: Switch to dark mode - scheme: slate - primary: black - accent: black + primary: red + accent: red toggle: icon: material/brightness-4 name: Switch to light mode @@ -80,12 +80,13 @@ nav: - Dashboarding: usage/advanced/dashboards.md - Compound Widgets: usage/advanced/compound-widgets.md - API Documentation: + - Pyplot: api/pyplot.md - Figure: api/figure.md - - MarketMap: api/market_map.md - - Toolbar: api/toolbar.md - Scales: api/scales.md - - Marks: api/marks.md - Axes: api/axes.md + - Marks: api/marks.md + - Toolbar: api/toolbar.md - Interactions: api/interactions.md - - Pyplot: api/pyplot.md + - MarketMap: api/market_map.md + - Contributing: contributing.md