Skip to content

Commit

Permalink
Draft documentation
Browse files Browse the repository at this point in the history
Use ipython directive where necessary

add theme to requirements

start using autosummarry

Fix warnings when building docs

Fix doctests

Add sphinx design to requirements

Add overview & panels in home page

Fix footer

Add styling & fix docstrings
  • Loading branch information
jules-ch committed Oct 9, 2022
1 parent b389846 commit 6014b35
Show file tree
Hide file tree
Showing 54 changed files with 593 additions and 1,171 deletions.
26 changes: 26 additions & 0 deletions docs/_static/index_api.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/_static/index_contribute.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/_static/index_getting_started.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/_static/index_user_guide.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap');

body {
font-family: 'Open Sans', sans-serif;
}

h1 {
font-family: "Lato", sans-serif;
}

pre, code {
font-size: 100%;
line-height: 155%;
}

/* Main page overview cards */

.sd-card {
border-radius: 0;
padding: 30px 10px 20px 10px;
margin: 10px 0px;
}

.sd-card .sd-card-header {
text-align: center;
}

.sd-card .sd-card-header .sd-card-text {
margin: 0px;
}

.sd-card .sd-card-img-top {
height: 52px;
width: 52px;
margin-left: auto;
margin-right: auto;
}

.sd-card .sd-card-header {
border: none;
color: #150458 !important;
font-size: var(--pst-font-size-h5);
font-weight: bold;
padding: 2.5rem 0rem 0.5rem 0rem;
}
3 changes: 0 additions & 3 deletions docs/_themes/.gitignore

This file was deleted.

37 changes: 0 additions & 37 deletions docs/_themes/LICENSE

This file was deleted.

31 changes: 0 additions & 31 deletions docs/_themes/README

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_themes/flask/layout.html

This file was deleted.

Loading

0 comments on commit 6014b35

Please sign in to comment.