Skip to content

Commit

Permalink
Rename to sphinx-visualized
Browse files Browse the repository at this point in the history
  • Loading branch information
jdillard committed Oct 28, 2024
1 parent b8171a9 commit 736bf6f
Show file tree
Hide file tree
Showing 16 changed files with 16 additions and 15 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Changelog
- Show the reference directionality in link graph
- Consolidate files to single location
- Support older versions of sphinx.util.fileutil.copy_asset()
- Rename extension to ``sphinx-visualized``

0.2.3
-----
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
include LICENSE
recursive-include sphinx_visualised/static *
recursive-include sphinx_visualized/static *
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

A Sphinx extension to generate interactive visualizations.

[![PyPI version](https://img.shields.io/pypi/v/sphinx-visualised.svg)](https://pypi.python.org/pypi/sphinx-visualised)
[![PyPI version](https://img.shields.io/pypi/v/sphinx-visualized.svg)](https://pypi.python.org/pypi/sphinx-visualized)
![Parallel safe](https://img.shields.io/badge/parallel%20safe-false-red)

## Documentation

See [sphinx-visualised documentation](https://sphinx-visualized.readthedocs.io/en/latest/) for installation and configuration instructions.
See [sphinx-visualized documentation](https://sphinx-visualized.readthedocs.io/en/latest/) for installation and configuration instructions.

## Demo

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ furo
esbonio
sphinx-contributors
sphinx
sphinx-visualised
sphinx-visualized
sphinxemoji
sphinxext-opengraph
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"sphinx_contributors",
"sphinx.ext.intersphinx",
"sphinxext.opengraph",
"sphinx_visualised",
"sphinx_visualized",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Directly install via pip by using:

.. code-block::
pip install sphinx-visualised
pip install sphinx-visualized
Add ``sphinx_visualised`` to the `extensions <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-extensions>`_ array in your Sphinx **conf.py**.
Add ``sphinx_visualized`` to the `extensions <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-extensions>`_ array in your Sphinx **conf.py**.
For example:

.. code-block:: python
extensions = ['sphinx_visualised']
extensions = ['sphinx_visualized']
Usage
-----
Expand Down
8 changes: 4 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ A `Sphinx`_ extension to generate interactive visualizations.

.. _Sphinx: http://sphinx-doc.org/

.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-visualised.svg
:target: https://pypi.python.org/pypi/sphinx-visualised
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-visualized.svg
:target: https://pypi.python.org/pypi/sphinx-visualized
:alt: Latest PyPi Version
.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-false-red
:target: #
:alt: Parallel read/write safe
.. |GitHub Stars| image:: https://img.shields.io/github/stars/jdillard/sphinx-visualised?style=social
:target: https://github.com/jdillard/sphinx-visualised
.. |GitHub Stars| image:: https://img.shields.io/github/stars/jdillard/sphinx-visualized?style=social
:target: https://github.com/jdillard/sphinx-visualized
:alt: GitHub Repository stars
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ requires = [
build-backend = "setuptools.build_meta"

[project]
name = "sphinx-visualised"
name = "sphinx-visualized"
description = "Visualization generator for Sphinx"
authors = [
{name = "Jared Dillard", email = "[email protected]"},
Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[metadata]
version = attr: sphinx_visualised.__version__
version = attr: sphinx_visualized.__version__

[options]
packages = find_namespace:
Expand All @@ -8,4 +8,4 @@ install_requires =

[options.packages.find]
where = .
include = sphinx_visualised*
include = sphinx_visualized*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 736bf6f

Please sign in to comment.