search

GenericMappingTools / sphinx_gmt

Sphinx extensions for GMT
https://www.generic-mapping-tools.org/sphinx_gmt
BSD 3-Clause "New" or "Revised" License
7 stars 1 forks source link

Rename the project #8

Closed seisman closed 5 years ago

seisman commented 5 years ago

pip search sphinx returns a list of packages related to sphinx. It seems most sphinx extensions have a name sphinx-xxx.

sphinx-advanced
Sphinx-Julia
sphinx-epytext
sphinx-tabs
sphinx-git
sphinx-sitemap
sphinx-boost
tachyonic-sphinx
sphinx-autorun
sphinx-graphiql
sphinx-csharp
sphinx-serve
sphinx-websequencediagrams
catkin-sphinx
sphinx-navtree
sphinx-nose
schemadisplay-sphinx
sphinx-server
sphinx-icontract
sphinx-refdoc
sphinx-confluence
zuul-sphinx
sphinx-jsonschema
sphinx-tsegsearch
sphinx-fortran
sphinx-scruffy
sphinx-prompt
sphinx-markdown
dragon-sphinx
sphinx-autoapi
sphinx-theme
sphinx-reload
anarchy-sphinx
tsuru-sphinx
sphinx-jsondomain
sphinx-a4doc
sphinx-JDLinker
sphinx-gallery
allanc-sphinx
sphinx-vlaamsecodex
sphinx-swagger
sphinx-elasticsearch
sphinx-revealjs
sphinx-astropy
sphinx-asciidoc
sphinx-testing
sphinx-click
sphinx-javalink
sphinx-tosca
sphinx-patchqueue
sphinx-pdj-theme
sphinx-simulink
sbo-sphinx
sphinx-lua
sphinx-nbexamples
sphinx-intl
django-sphinx
sphinx-argparse
sphinx-js
sphinx-view
sphinx-pyreverse
sphinx-issues
sphinxcontrib-getstart-sphinx
sphinx-stylo
sphinx-paramlinks
sphinx-links
sphinx-measurement
sphinx-dust
sphinx-hwt
sphinx-multibuild
sphinx-automodapi
pytest-sphinx
sphinx-autorun-ebs
jupyter-sphinx-theme
sphinx-autorun-ng
sphinx-glpi-theme
epfl-sphinx-theme
sphinx-guillotina-theme
sphinx-readable-theme
sphinx-rigado-extensions
sphinx-typlog-theme
hachibee-sphinx-theme
sphinx-bootstrap-theme
sphinx-quickstart-plus
zerovm-sphinx-theme
sphinx-rigado-theme
sphinx-compas-theme
sphinx-nameko-theme
dask-sphinx-theme
oe-sphinx-theme
sphinx-opnfv-theme
pytorch-sphinx-theme
sphinx-kml
travis-sphinx
sphinx-me
sphinx-catalystcloud-theme
sphinx-zon-theme
sphinx-ustack-theme
sphinx-gettext-helper
nengo-sphinx-theme

Maybe we can rename the project to sphinx-gmt.

leouieda commented 5 years ago

The problem with the hyphen is that it can't be used for the package name. So you'd pip install sphinx-gmt but import sphinx_gmt or something like that. I really don't like that. Maybe sphinx_gmt or sphinxgmt instead?

seisman commented 5 years ago

Since it's a sphinx extension, do we really need to import it? I think we only need to add it to conf.py:

 extensions = [
     "sphinx-gmt.gmtplot",
 ]
seisman commented 5 years ago

Yeah, you're right. Sometimes we still need to import it.

leouieda commented 5 years ago

Yeah, sphinx does the importing based on those strings.