Skip to content

Commit 4053893

Browse files
authored
Switch to using sphinx_holoviz_theme and fixing up holoviz references (#150)
1 parent e89a45b commit 4053893

File tree

11 files changed

+23
-22
lines changed

11 files changed

+23
-22
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66

77
| | |
88
| --- | --- |
9-
| Build Status | [![Linux/MacOS Build Status](https://travis-ci.org/pyviz/nbsite.svg?branch=master)](https://travis-ci.org/pyviz/nbsite) [![Windows Build status](https://img.shields.io/appveyor/ci/pyviz/nbsite/master.svg?logo=appveyor)](https://ci.appveyor.com/project/pyviz/nbsite/branch/master) |
10-
| Coverage | [![codecov](https://codecov.io/gh/pyviz/nbsite/branch/master/graph/badge.svg)](https://codecov.io/gh/pyviz/nbsite) |
11-
| Latest dev release | [![Github tag](https://img.shields.io/github/tag/pyviz/nbsite.svg?label=tag&colorB=11ccbb)](https://github.com/pyviz/nbsite/tags) |
12-
| Latest release | [![Github release](https://img.shields.io/github/release/pyviz/nbsite.svg?label=tag&colorB=11ccbb)](https://github.com/pyviz/nbsite/releases) [![PyPI version](https://img.shields.io/pypi/v/nbsite.svg?colorB=cc77dd)](https://pypi.python.org/pypi/nbsite) [![nbsite version](https://img.shields.io/conda/v/pyviz/nbsite.svg?colorB=4488ff&style=flat)](https://anaconda.org/pyviz/nbsite) [![conda-forge version](https://img.shields.io/conda/v/conda-forge/nbsite.svg?label=conda%7Cconda-forge&colorB=4488ff)](https://anaconda.org/conda-forge/nbsite) [![defaults version](https://img.shields.io/conda/v/anaconda/nbsite.svg?label=conda%7Cdefaults&style=flat&colorB=4488ff)](https://anaconda.org/anaconda/nbsite) |
9+
| Build Status | [![Linux/MacOS Build Status](https://travis-ci.org/pyviz-dev/nbsite.svg?branch=master)](https://travis-ci.org/pyviz-dev/nbsite) [![Windows Build status](https://img.shields.io/appveyor/ci/pyviz-dev/nbsite/master.svg?logo=appveyor)](https://ci.appveyor.com/project/pyviz-dev/nbsite/branch/master) |
10+
| Coverage | [![codecov](https://codecov.io/gh/pyviz-dev/nbsite/branch/master/graph/badge.svg)](https://codecov.io/gh/pyviz-dev/nbsite) |
11+
| Latest dev release | [![Github tag](https://img.shields.io/github/tag/pyviz-dev/nbsite.svg?label=tag&colorB=11ccbb)](https://github.com/pyviz-dev/nbsite/tags) |
12+
| Latest release | [![Github release](https://img.shields.io/github/release/pyviz-dev/nbsite.svg?label=tag&colorB=11ccbb)](https://github.com/pyviz-dev/nbsite/releases) [![PyPI version](https://img.shields.io/pypi/v/nbsite.svg?colorB=cc77dd)](https://pypi.python.org/pypi/nbsite) [![nbsite version](https://img.shields.io/conda/v/pyviz/nbsite.svg?colorB=4488ff&style=flat)](https://anaconda.org/pyviz/nbsite) [![conda-forge version](https://img.shields.io/conda/v/conda-forge/nbsite.svg?label=conda%7Cconda-forge&colorB=4488ff)](https://anaconda.org/conda-forge/nbsite) [![defaults version](https://img.shields.io/conda/v/anaconda/nbsite.svg?label=conda%7Cdefaults&style=flat&colorB=4488ff)](https://anaconda.org/anaconda/nbsite) |
1313
| Docs | [![gh-pages](https://img.shields.io/github/last-commit/pyviz/nbsite/gh-pages.svg)](https://github.com/pyviz/nbsite/tree/gh-pages) [![site](https://img.shields.io/website-up-down-green-red/https/nbsite.pyviz.org.svg)](https://nbsite.pyviz.org) |
1414

1515
## What is it?
1616

1717
NBSite lets you build a website from a set of notebooks plus a minimal
1818
amount of config. Sites built with nbsite include
1919
[pyviz.org](https://pyviz.org),
20-
[datashader.org](http://datashader.org/), and [hvplot.pyviz.org](https:/hvplot.pyviz.org).
20+
[datashader.org](https://datashader.org/), and [hvplot.pyviz.org](https:/hvplot.pyviz.org).
2121

2222
The idea behind nbsite is that notebooks can simultaneously be
2323
documentation (things you want to tell people about), examples (a

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
version = release = nbsite.__version__
1515

1616
html_static_path += ['_static']
17-
html_theme = 'sphinx_pyviz_theme'
17+
html_theme = 'sphinx_holoviz_theme'
1818
html_theme_options = {
1919
'custom_css': 'site.css',
2020
'logo': 'nbsite-logo.png',

examples/Development.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"\n",
1818
"(todo, see travis for commands to run locally)\n",
1919
"\n",
20-
"Update pyviz.github.io/nbsite: `git tag -a x.y.z -m \"message\" && git push --tags`\n"
20+
"Update nbsite.pyviz.org: `git tag -a x.y.z -m \"message\" && git push --tags`\n"
2121
]
2222
},
2323
{

examples/Usage.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
"\n",
4646
"You can skip and/or modify various steps below depending on what you already have. If you do skip this steps you will need to at least create a doc dir with a conf.py in it. See nbsite/templates/basic for an example.\n",
4747
"\n",
48-
"1. Create a set of basic pages: `nbsite init` (will not overwrite existing files). Use the `--theme` option to specify if you want the pyviz setup.\n",
48+
"1. Create a set of basic pages: `nbsite init` (will not overwrite existing files). Use the `--theme` option to specify if you want the holoviz setup.\n",
4949
"\n",
5050
"2. Edit conf.py as appropriate for your project.\n",
5151
"\n",
@@ -101,19 +101,19 @@
101101
"metadata": {},
102102
"source": [
103103
"## Customizing Style\n",
104-
"For all the sites that have been generated so far, we used the `sphinx_pyviz_theme`. You may be able to use a different theme (untested).\n",
104+
"For most of the sites that have been generated so far, we used the `sphinx_holoviz_theme`. [PyViz](https://pyviz.org) is the exception and uses the Alabaster theme.\n",
105105
"\n",
106106
"\n",
107-
"### PyViz\n",
107+
"### HoloViz\n",
108108
"\n",
109-
"To use the pyviz theme: pip/conda install sphinx_pyviz_theme and set `html_theme` to `sphinx_pyviz_theme`. To control the look and feel, change `html_theme_options` in conf.py:\n",
109+
"To use the holoviz theme: pip/conda install sphinx_holoviz_theme and set `html_theme` to `sphinx_holoviz_theme`. To control the look and feel, change `html_theme_options` in conf.py:\n",
110110
"\n",
111111
"* `logo` and `favicon`: provide paths relative to `html_static_path` (`doc/_static` by default)\n",
112112
"* `primary_color`, `primary_color_dark` and `secondary_color`: control the colors that the website uses for header, nav, links... These can be css named colors, or hex colors.\n",
113113
"* `second_nav`: Boolean indicating whether to use a second nav bar.\n",
114114
"* `custom_css`: path relative to `html_static_path` overriding styles. Styles come first from the theme's `main.css_t`, which is populated with the colors options, extended/overridden by nbsite's own css `nbsite/_shared_static/nbsite.css`, and then extended/overridden by your site's own css. \n",
115115
"\n",
116-
"**NOTE:** Only use the custom_css to overwrite small pieces of the css not to make general improvements. If you have general improvements, please open a PR on the [theme repo](https://github.com/pyviz-dev/sphinx_pyviz_theme).\n",
116+
"**NOTE:** Only use the custom_css to overwrite small pieces of the css not to make general improvements. If you have general improvements, please open a PR on the [theme repo](https://github.com/pyviz-dev/sphinx_holoviz_theme).\n",
117117
"\n",
118118
"## Customizing running of IPython notebooks\n",
119119
"\n",

nbsite/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def main(args=None):
2222

2323
init_parser = subparsers.add_parser("init", help=inspect.getdoc(init))
2424
_add_common_args(init_parser,'--project-root','--doc')
25-
init_parser.add_argument('--theme', type=str, help='sphinx theme to use in template', choices=['pyviz', ''], default='')
25+
init_parser.add_argument('--theme', type=str, help='sphinx theme to use in template', choices=['holoviz', ''], default='')
2626
_set_defaults(init_parser,init)
2727

2828
generaterst_parser = subparsers.add_parser("generate-rst", help=inspect.getdoc(generate_rst))
File renamed without changes.
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ About PROJECT
22
=============
33

44
PROJECT is supported and maintained by `Anaconda
5-
<https://www.anaconda.com>`_. PROJECT is part of the `PyViz
6-
<https://pyviz.org>`_ project to make Python data visualization tools
7-
simpler and more powerful.
5+
<https://www.anaconda.com>`_. PROJECT is part of the `HoloViz
6+
<https://holoviz.org>`_ ecosystem, which strives to make browser-based
7+
data visualization in Python easier to use, easier to learn, and more
8+
powerful.
89

910
The primary PyViz developers are Philipp Rudiger, James A. Bednar,
1011
Julia Signell and Jean-Luc Stevens, with bug reports and patches from
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
# edit things below as appropriate for your project
88

99
project = u'Project'
10-
authors = u'PyViz Developers'
10+
authors = u'HoloViz Developers'
1111
copyright = u'2019 ' + authors
1212
description = 'Short description for html meta description.'
1313
site = 'https://{}.pyviz.org'.format(project)
1414
version = release = '0.0.1'
1515

1616
html_static_path += ['_static']
17-
html_theme = 'sphinx_pyviz_theme'
17+
html_theme = 'sphinx_holoviz_theme'
1818
# logo file etc should be in html_static_path, e.g. _static
1919
# only change colors in primary, primary_dark, and secondary
2020
html_theme_options = {
@@ -47,7 +47,7 @@
4747
'LINKS': _NAV,
4848
'SOCIAL': (
4949
('Gitter', 'https://gitter.im/pyviz/pyviz'),
50-
('Twitter', 'https://twitter.com/pyviz_org'),
51-
('Github', 'https://github.com/pyviz/{}'.format(project)),
50+
('Twitter', 'https://twitter.com/holoviz_org'),
51+
('Github', 'https://github.com/holoviz/{}'.format(project)),
5252
)
5353
})
File renamed without changes.

nbsite/tests/test_cmd.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -495,4 +495,4 @@ def test_build_with_keep_numbers_passes_even_when_link_target_does_not_exist(tmp
495495
html = (project / "builtdocs" / "1_First_Notebook.html").read_text()
496496
assert '<a href="0_Zeroth_Notebook.html">right number</a>' in html
497497
assert '<a href="1_Zeroth_Notebook.html">wrong number</a>' in html
498-
assert '<a href="Zeroth_Notebook.html">no number</a>' in html
498+
assert '<a href="Zeroth_Notebook.html">no number</a>' in html

0 commit comments

Comments
 (0)