Skip to content

Commit

Permalink
Redesign to match other ABR sites
Browse files Browse the repository at this point in the history
FusionBox provided the starting point. We added some additional
features, like ScrollSpy, a sticky sidebar, and more admonition
styles.

This commit also switches to using Nengo Bones to manage
meta files in the repository, which has the intended side effect
of using the Nengo license, not the Apache license, as none of the
files in this repository have any crate.io code anymore.

Add notebook test.
  • Loading branch information
tbekolay authored and drasmuss committed Jul 16, 2019
1 parent e10e120 commit 99fbb9f
Show file tree
Hide file tree
Showing 68 changed files with 1,141 additions and 17,369 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ htmlcov
.idea
.pytest_cache/
.doctrees/
.ci/
.ipynb_checkpoints/
69 changes: 69 additions & 0 deletions .nengobones.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
project_name: Nengo Sphinx Theme
pkg_name: nengo_sphinx_theme
repo_name: nengo/nengo-sphinx-theme

description: Sphinx theme for Nengo project documentation pages
copyright_start: 2019

travis_yml:
python: 3.6
jobs:
- script: static
- script: docs
pypi_user: tbekolay
deploy_dists:
- sdist
- bdist_wheel

ci_scripts:
- template: static
- template: docs
- template: deploy

contributing_rst: {}

contributors_rst: {}

license_rst: {}

manifest_in:
global-include:
- "*.conf"
- "*.html"

setup_py:
entry_points:
sphinx.html_themes:
- nengo_sphinx_theme=nengo_sphinx_theme
include_package_data: True
install_req:
- sphinx>=1.8
docs_req:
- jupyter
- matplotlib
- nbsphinx
- nengo
classifiers:
- "Development Status :: 4 - Beta"
- "Framework :: Nengo"
- "Intended Audience :: Developers"
- "License :: Free for non-commercial use"
- "Operating System :: Microsoft :: Windows"
- "Operating System :: POSIX :: Linux"
- "Programming Language :: Python"
- "Programming Language :: Python :: 3.5"
- "Programming Language :: Python :: 3.6"
- "Programming Language :: Python :: 3.7"
- "Topic :: Software Development"

setup_cfg:
pylint:
disable:
- missing-docstring

docs_conf_py:
exclude_patterns:
- examples/test-example.ipynb
extensions:
- nengo_sphinx_theme.ext.resolvedefaults
analytics_id: UA-41658423-2
102 changes: 102 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Automatically generated by nengo-bones, do not edit this file directly
# Version: 0.2.1

language: python
python: 3.6
notifications:
email:
on_success: change
on_failure: change
cache: pip

dist: trusty

env:
global:
- SCRIPT="test"
- TEST_ARGS=""
- COV_CORE_SOURCE= # early start pytest-cov engine
- COV_CORE_CONFIG=.coveragerc
- COV_CORE_DATAFILE=.coverage.eager
- BRANCH_NAME="${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}"

jobs:
include:
-
env:
SCRIPT="static"
-
env:
SCRIPT="docs"
addons:
apt:
packages:
- pandoc
- stage: deploy
if: branch =~ ^release-candidate-* OR tag =~ ^v[0-9]*
env: SCRIPT="deploy"
cache: false
deploy:
- provider: pypi
server: https://test.pypi.org/legacy/
user: tbekolay
password: $PYPI_TOKEN
distributions: "sdist bdist_wheel "
on:
all_branches: true
condition: $TRAVIS_BRANCH =~ ^release-candidate-*
condition: $TRAVIS_TAG = ""
- provider: pypi
user: tbekolay
password: $PYPI_TOKEN
distributions: "sdist bdist_wheel "
on:
all_branches: true
condition: $TRAVIS_TAG =~ ^v[0-9]*

before_install:
# export travis_terminate for use in scripts
- export -f travis_terminate
_travis_terminate_linux
_travis_terminate_osx
_travis_terminate_unix
_travis_terminate_windows
# upgrade pip
- pip install pip --upgrade
# install/run nengo-bones
- pip install nengo-bones
- bones-generate --output-dir .ci ci-scripts
- bones-check
# display environment info
- pip freeze

install:
- .ci/$SCRIPT.sh install
- pip freeze

after_install:
- .ci/$SCRIPT.sh after_install

before_script:
- .ci/$SCRIPT.sh before_script

script:
- .ci/$SCRIPT.sh script

before_cache:
- .ci/$SCRIPT.sh before_cache

after_success:
- .ci/$SCRIPT.sh after_success

after_failure:
- .ci/$SCRIPT.sh after_failure

before_deploy:
- .ci/$SCRIPT.sh before_deploy

after_deploy:
- .ci/$SCRIPT.sh after_deploy

after_script:
- .ci/$SCRIPT.sh after_script
9 changes: 7 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,15 @@ Release History
- Removed
- Fixed
0.13.0 (unreleased)
===================
1.0.0 (unreleased)
==================

**Changed**

- The look-and-feel of the theme was completely redone.
(`#35 <https://github.com/nengo/nengo-sphinx-theme/pull/35>`__)
- This project is now licensed with the Nengo license.
(`#35 <https://github.com/nengo/nengo-sphinx-theme/pull/35>`__)

0.12.0 (May 29, 2019)
=====================
Expand Down
53 changes: 45 additions & 8 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,47 @@
============
Contributing
============
.. Automatically generated by nengo-bones, do not edit this file directly
.. Version: 0.2.1
**********************************
Contributing to Nengo Sphinx Theme
**********************************

Issues and pull requests are always welcome!
We appreciate help from the community to make Nengo Sphinx Theme better.

Filing issues
=============

If you find a bug in Nengo Sphinx Theme,
or think that a certain feature is missing,
please consider
`filing an issue <https://github.com/nengo/nengo-sphinx-theme/issues>`_!
Please search the currently open issues first
to see if your bug or feature request already exists.
If so, feel free to add a comment to the issue
so that we know that multiple people are affected.

Thank you for your interest in contributing.
Making pull requests
====================

If you want to fix a bug or add a feature to Nengo Sphinx Theme,
we welcome pull requests.
Ensure that you fill out all sections of the pull request template,
deleting the comments as you go.
We check most aspects of code style automatically.
Please refer to our
`code style guide <https://www.nengo.ai/style.html>`_
for things that we check manually.

Contributor agreement
=====================

We require that all contributions be covered under
our contributor assignment agreement. Please see
`the agreement <https://www.nengo.ai/caa.html>`_
for instructions on how to sign.

More details
============

The Nengo Sphinx theme is not accepting contributions.
It is a fork of the Crate Docs Theme.
Please contribute to the original `Crate Docs Theme
<https://github.com/crate/crate-docs-theme>`_.
For more details on how to contribute to Nengo,
please see the `developer guide <https://www.nengo.ai/contributing.html>`_.
10 changes: 10 additions & 0 deletions CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. Automatically generated by nengo-bones, do not edit this file directly
.. Version: 0.2.1
*******************************
Nengo Sphinx Theme contributors
*******************************

See https://www.nengo.ai/people.html for a list of
the many people who have worked on Nengo Sphinx Theme;
thank you for your contributions!
Loading

0 comments on commit 99fbb9f

Please sign in to comment.