Skip to content

DOC: start using new bootstrap-based sphinx theme #28623

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

Merged
merged 6 commits into from
Oct 4, 2019
Merged

DOC: start using new bootstrap-based sphinx theme #28623

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9b8d1c
Use pandas-sphin-theme in docs (from github master)
jorisvandenbossche Sep 25, 2019
78f6b35
move install into getting_started + remove ecosystem from top-level n…
jorisvandenbossche Sep 25, 2019
1cfba0a
generate requirements.txt
jorisvandenbossche Sep 26, 2019
f73af22
Merge remote-tracking branch 'upstream/master' into docs-new-theme
jorisvandenbossche Sep 26, 2019
5f5a609
update link
jorisvandenbossche Sep 26, 2019
35c34c7
remove import
jorisvandenbossche Sep 26, 2019
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
1 change: 1 addition & 0 deletions doc/redirects.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ whatsnew,whatsnew/index
release,whatsnew/index

# getting started
install,getting_started/install
10min,getting_started/10min
basics,getting_started/basics
comparison_with_r,getting_started/comparison/comparison_with_r
Expand Down
6 changes: 4 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
from numpydoc.docscrape import NumpyDocString
from sphinx.ext.autosummary import _import_by_name

import pandas_sphinx_theme # noqa
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this needed? may be add a comment in the code to explain?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might actually not be needed, will try out (I was assuming it is needed, because in the init of the package we have some sphinx extensions added, but probably sphinx imports the package anyway if you set it as the html theme)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't seem needed. Removed.


logger = logging.getLogger(__name__)

# https://github.com/sphinx-doc/sphinx/pull/2325/files
Expand Down Expand Up @@ -191,7 +193,7 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = "nature_with_gtoc"
html_theme = "pandas_sphinx_theme"

# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
Expand All @@ -204,7 +206,7 @@
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ["themes"]
# html_theme_path = ["themes"]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
2 changes: 2 additions & 0 deletions doc/source/ecosystem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ecosystem:

{{ header }}
Expand Down
1 change: 1 addition & 0 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Getting started
.. toctree::
:maxdepth: 2

install
overview
10min
basics
Expand Down
0 doc/source/install.rst → doc/source/getting_started/install.rst
View file
Open in desktop
File renamed without changes.
4 changes: 1 addition & 3 deletions doc/source/index.rst.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,8 @@ See the :ref:`overview` for more detail about what's in the library.
{% endif %}
{% if not single_doc %}
What's New in 1.0.0 <whatsnew/v1.0.0>
install
getting_started/index
user_guide/index
ecosystem
{% endif -%}
{% if include_api -%}
reference/index
Expand All @@ -54,9 +52,9 @@ See the :ref:`overview` for more detail about what's in the library.
{% endif %}

* :doc:`whatsnew/v1.0.0`
* :doc:`install`
* :doc:`getting_started/index`

* :doc:`getting_started/install`
* :doc:`getting_started/overview`
* :doc:`getting_started/10min`
* :doc:`getting_started/basics`
Expand Down
2 changes: 2 additions & 0 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,5 @@ dependencies:
- xlwt # pandas.read_excel, DataFrame.to_excel, pandas.ExcelWriter, pandas.ExcelFile
- odfpy # pandas.read_excel
- pyreadstat # pandas.read_spss
- pip:
- git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
3 changes: 2 additions & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,5 @@ xlrd
xlsxwriter
xlwt
odfpy
pyreadstat
pyreadstat
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master