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

Migrate pydocs sphinx docs to project #43

Merged
merged 2 commits into from
Jun 12, 2020
Merged

Migrate pydocs sphinx docs to project #43

merged 2 commits into from
Jun 12, 2020

Conversation

taldcroft
Copy link
Member

Description

The ancient structure for project documentation was a single RST file in the pydocs repo, so for instance one finds Chandra.Time.rst in that repo.

This PR makes a docs directory and puts the standard sphinx-quickstart structure there with some mods:

  • Use the bootstrap-astropy theme. I think this theme is quite clean and modern. It requires that the astropy-sphinx-theme be installed. This is available on conda-forge. We'll need to customize a bit to replace the top-bar astropy logo / link with Ska.
  • Use __version__ import from the package as the version and release.
  • Adds the GitHub pages extension to enable an automated docs build / publish process. (Note, some repos like eng_archive require Ska data to build the docs.)

Testing

@taldcroft taldcroft merged commit 91a95a6 into master Jun 12, 2020
@taldcroft taldcroft deleted the docs branch June 12, 2020 21:25
@javierggt
Copy link
Contributor

I like the idea of moving all to the astropy theme, with Ska mods.

@javierggt javierggt mentioned this pull request Dec 7, 2020
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 this pull request may close these issues.

2 participants