Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add dev tool to build themes #379

Closed
wants to merge 13 commits into from
Closed

Add dev tool to build themes #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d65d437
created command line tool to create all html theme docs at once
s-weigand Jan 10, 2020
08803a0
refactored theme_builder file/folder creation, to be more compact
s-weigand Jan 13, 2020
8cc6dcf
added guide on how to use theme_builder
s-weigand Jan 13, 2020
879382f
made ref_to_theme_name more reliable
s-weigand Jan 13, 2020
7bda7e3
added args for to use '-d' on building when possible to share build c…
s-weigand Jan 13, 2020
0143351
removed now outdated ignored files
s-weigand Jan 13, 2020
04c8603
updated docstring of validate_theme_list
s-weigand Jan 13, 2020
2b7dfeb
Changed the assumption to generate the diff
s-weigand Jan 15, 2020
50bc49a
changed explanation what theme branches are for
s-weigand Jan 15, 2020
c27198c
Fixed typos in contributing guide
s-weigand Jan 17, 2020
26618b1
Made fetching optional if the Repo exists
s-weigand Jan 17, 2020
de2dd94
refactored diffing to only us GitPython
s-weigand Jan 17, 2020
2e3404c
refactored diffing to not use '--output-indicator-new' since it is
s-weigand Jan 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ nbsphinx.egg-info/
.python-version
.vscode
doc/_build

dev_utils/_build
dev_utils/tmp
dev_utils/requirements_themes.txt
29 changes: 29 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,34 @@ Again, you'll probably have to use ``python`` instead of ``python3``.
The generated files will be available in the directories ``build/sphinx/html/``
and ``build/sphinx/latex/``, respectively.

Building Themes
---------------

The ``nbsphinx`` documentation is available in over 30 different `HTML themes`_,
with each having its own branch ending in ``-theme``.

To simplify the building and testing of themes,
which is especially needed when changing CSS,
we provide you with command line tool to build all themes
or a user specified subset.
The tool is located at ``dev_utils/theme_builder.py`` and can be run with::

python3 dev_utils/theme_builder.py

On its first run, it will just create ``dev_utils/requirements_themes.txt``
which contains the dependencies to build all themes and instructs
you how to install them.
And after it will by default build all supported themes.

If you just want to build a subset of the themes
(i.e. ``alabaster`` and ``sphinx_rtd_theme``), simply run::

python3 dev_utils/theme_builder.py --themes alabaster rtd

for more information run::

python3 dev_utils/theme_builder.py --help

.. _PyPI: https://pypi.org/project/nbsphinx/
.. _Github: https://github.com/spatialaudio/nbsphinx/
.. _`HTML themes`: https://nbsphinx.readthedocs.io/usage.html#HTML-Themes
Loading