Skip to content

Commit

Permalink
Remove old Website development documentation
Browse files Browse the repository at this point in the history
We now use Readthedocs for the documentation, so the scripts and
documentation relating to building and pushing docs to the Github pages
is obsolete.

In addition, the website is now served from a new repository.
  • Loading branch information
gmarkall committed May 4, 2023
1 parent 2754042 commit 680156c
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 182 deletions.
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ recursive-include docs *.ipynb *.txt *.py Makefile *.rst
recursive-include examples *.py

prune docs/_build
prune docs/gh-pages
include numba/_version.py
150 changes: 0 additions & 150 deletions docs/gh-pages.py

This file was deleted.

30 changes: 1 addition & 29 deletions docs/source/developer/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -475,39 +475,11 @@ build and check the documentation::
$ make html
$ open _build/html/index.html

Core developers can upload this documentation to the Numba website
at https://numba.pydata.org by using the ``gh-pages.py`` script under ``docs``::

$ python gh-pages.py version # version can be 'dev' or '0.16' etc

then verify the repository under the ``gh-pages`` directory and use
``git push``.

Web site homepage
'''''''''''''''''

The Numba homepage on https://numba.pydata.org can be fetched from here:
https://github.com/numba/numba-webpage

After pushing documentation to a new version, core developers will want to
update the website. Some notable files:

* ``index.rst`` # Update main page
* ``_templates/sidebar_versions.html`` # Update sidebar links
* ``doc.rst`` # Update after adding a new version for numba docs
* ``download.rst`` # Updata after uploading new numba version to pypi

After updating run::

$ make html

and check out ``_build/html/index.html``. To push updates to the Web site::

$ python _scripts/gh-pages.py

then verify the repository under the ``gh-pages`` directory. Make sure the
``CNAME`` file is present and contains a single line for ``numba.pydata.org``.
Finally, use ``git push`` to update the website.
https://github.com/numba/numba.github.com


.. _typeguard: https://typeguard.readthedocs.io/en/latest/
Expand Down
2 changes: 0 additions & 2 deletions docs/source/developer/repomap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ Documentation
- :ghfile:`docs/Makefile` - Used to build Sphinx docs with ``make``
- :ghfile:`docs/source` - ReST source for Numba documentation
- :ghfile:`docs/_static/` - Static CSS and image assets for Numba docs
- :ghfile:`docs/gh-pages.py` - Utility script to update Numba docs (stored
as gh-pages)
- :ghfile:`docs/make.bat` - Not used (remove?)
- :ghfile:`docs/requirements.txt` - Pip package requirements for building docs
with Read the Docs.
Expand Down

0 comments on commit 680156c

Please sign in to comment.