Repository navigation
Install sphinx configuration and extensions - #33
Merged
Merged
Conversation
Member
|
+1 |
Member
|
I initially was worried that this would require astropy to be installed to build the docs, but this will be necessary anyway once we use things like autosummary and automodule. Looks good to me! |
Member
There was a problem hiding this comment.
It looks like the rst_epilog is already defined in astropy.sphinx.conf ... so perhaps the astropy-specific one should be
# rst_epilog is added to the end of RST files - a good place to put substitutions to
# be used globally. astropy.sphix.conf already defines some substitutions like
# _Astropy: include here only substitutions that are unlikely to be used in
# affiliated packages
rst_epilog = rst_epilog+"""
"""
Member
|
Other than that one small bit about the rst_epilog, this looks great to me. |
…". This means that both the core astropy doc build and affiliated packages will use the same extensions and configuration options, and affiliated packages do not need to be updated when doc settings and extensions need to change.
eteq
added a commit
that referenced
this pull request
Oct 26, 2011
Move sphinx doc-building extensions and (part of) conf.py into the source tree to allow affiliated packages to access them.
mhvk
pushed a commit
to mhvk/astropy
that referenced
this pull request
Jul 17, 2013
…dle-output Allow (nearly all) in-place calculations, update tests, cleanup
keflavich
pushed a commit
to keflavich/astropy
that referenced
this pull request
Oct 9, 2013
Move sphinx doc-building extensions and (part of) conf.py into the source tree to allow affiliated packages to access them.
embray
pushed a commit
to embray/astropy
that referenced
this pull request
Jan 23, 2015
Fix astropy#2418 -- fix crash in smart_resolver when lookup fails
astrofrog
pushed a commit
to astropy/sphinx-automodapi
that referenced
this pull request
Jan 27, 2018
Move sphinx doc-building extensions and (part of) conf.py into the source tree to allow affiliated packages to access them.
astrofrog
pushed a commit
to astropy/sphinx-astropy
that referenced
this pull request
Jan 29, 2018
Move sphinx doc-building extensions and (part of) conf.py into the source tree to allow affiliated packages to access them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It's important to keep the settings used to build the core astropy docs and the affiliated packages in sync to ease the inclusion of affiliated packages in the core later on, and to ensure a consistent look across these packages. Also, distributing bugfixes in the extensions, or updating them when Numpy does, is much easier to do in one place.
This suggestion came about in response to how the affiliated package template layout was proposed here:
astropy/package-template#1