Skip to content
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.

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

Remove the Sphinx themes/extensions from the repository? #7847

Closed
seisman opened this issue Sep 25, 2023 · 4 comments · Fixed by #7927
Closed

Remove the Sphinx themes/extensions from the repository? #7847

seisman opened this issue Sep 25, 2023 · 4 comments · Fixed by #7927
Assignees

Comments

@seisman
Copy link
Member

seisman commented Sep 25, 2023

Currently, we include the source codes of the Sphinx theme sphinx_rtd_theme (https://github.com/GenericMappingTools/gmt/tree/master/doc/rst/themes/rtd) and some Sphinx extensions (https://github.com/GenericMappingTools/gmt/tree/master/doc/rst/_extensions) in the GMT repository.

I think the main reasons to include them in GMT are:

  1. Developers/users don't have to install these Python packages to build the GMT documentation
  2. They're under our control so the documentation won't suddenly break [Actually it still breaks sometimes due to changes in Sphinx].

However, including them in GMT also have some downsides:

  1. The size of the GMT source tarballs increases by about 3 MB.
  2. We have to maintain them manually (xref Add maintenance instructions for sphinx extensions/themes #6010)
  3. We can't use some good Sphinx extensions (e.g., https://sphinx-design.readthedocs.io/en/latest/) because their source codes are complicated or too big to be included in the repository

Since all the Sphinx packages can be installed using pip and pip itself is also easy to install,
what about removing them from the GMT repository?

@seisman
Copy link
Member Author

seisman commented Oct 16, 2023

Comments? @PaulWessel @joa-quim @GenericMappingTools/gmt-docs

@PaulWessel
Copy link
Member

I can live with that. Let's here form @joa-quim first.

@maxrjones
Copy link
Member

I'd prefer for them to be removed

@joa-quim
Copy link
Member

I guess I can live too with some more pipings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants