Skip to content

Commit

Permalink
more tidying
Browse files Browse the repository at this point in the history
  • Loading branch information
cliffckerr committed Dec 1, 2020
1 parent c30b5b3 commit 70bbd85
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
.. image:: docs/sciris-logo.png
:scale: 10%
:align: center

Welcome to Sciris
=================

What is Sciris?
---------------

Glad you asked! `Sciris <http://sciris.org>`__ is a flexible open source framework for building scientific web applications using Python and JavaScript. It comes in two parts: ``sciris`` is a collection of tools that should make scientific Python coding a more pleasant experience, while ``scirisweb`` is a collection of tools that allow you to easily build Python webapps. Sciris is built on Numpy and Matplotlib, while ScirisWeb is built on Vue.js, Flask, Twisted, Redis, and ``mpld3``. Full documentation is available at http://docs.sciris.org.

Glad you asked! `Sciris <http://sciris.org>`__ is a flexible open source framework for building scientific web applications using Python and JavaScript. It comes in two parts: ``sciris`` is a collection of tools that should make scientific Python coding a more pleasant experience, while ``scirisweb`` is a collection of tools that allow you to easily build Python webapps. Sciris is built on Numpy and Matplotlib, while ScirisWeb is built on Vue.js, Flask, Twisted, Redis, and ``mpld3``. Sciris is available on `PyPi <https://pypi.org/project/sciris/>`__ and `GitHub <https://github.com/sciris/sciris>`__. Full documentation is available at http://docs.sciris.org.

Highlights
~~~~~~~~~~
Expand Down Expand Up @@ -176,7 +179,6 @@ The easiest way to install Sciris is by using pip: ``pip install scirisweb`` (wh

>>> import sciris
>>> import scirisweb
>>>


Installing on Windows
Expand Down
53 changes: 53 additions & 0 deletions docs/_static/theme_overrides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal;
}

.wy-table-responsive table td p {
font-size: 100%;
}

footer p {
font-size: 14px;
margin-top: 0px;
margin-bottom: 0px;
}

h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
font-family: "Montserrat", "Lato", "Open Sans", sans-serif;
margin-bottom: 0.5em;
}

h1 {
margin-bottom: 1.0em;
}

h2 {
font-size: 125%;
color: #0055af !important;
margin-bottom: 1.0em;
}

h3 {
font-size: 115%;
color: #38761d;
}

h4 {
font-size: 105%;
color: #bf9000;
}

div.document span.search-highlight {
background-color: yellow;
}

.btn {
margin-bottom: 10px;
}

.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td, .wy-table-backed, .wy-table-odd td, .wy-table-striped tr:nth-child(2n-1) td {
background-color: #acf;
}
tr.row-even {
background-color: #def;
}
12 changes: 11 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,14 @@
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = "sciris-logo-small.png"
html_favicon = "favicon.ico"
html_favicon = "favicon.ico"
html_static_path = ['_static']
html_context = {
'css_files': [
'_static/theme_overrides.css'
]
}

html_show_sourcelink = True
html_show_sphinx = False
htmlhelp_basename = 'Sciris'
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. title:: Sciris

.. image:: sciris-logo.png
.. image:: docs/sciris-logo.png
:scale: 40%
:align: center

Expand Down

0 comments on commit 70bbd85

Please sign in to comment.