Skip to content

Commit

Permalink
Merge pull request #1574 from ChakriCherukuri/mkdocs-cleanup
Browse files Browse the repository at this point in the history
Mkdocs cleanup
  • Loading branch information
ChakriCherukuri committed Feb 3, 2023
2 parents 81ba01f + a171469 commit 8882e81
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 0 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions docs/usage/figure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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
19 changes: 10 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 8882e81

Please sign in to comment.