Skip to content

Commit

Permalink
rename site-preprocess/config.py template-config.py; add TODOs to do …
Browse files Browse the repository at this point in the history
…that in the command (else ReadTheDocs gets confused by seeing 2 config.py files and doesn't always use the correct one)
  • Loading branch information
weedySeaDragon committed Aug 31, 2016
1 parent 7219a40 commit bcf0815
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,8 @@ def generateSphinxConfigAction(state: State): State = {
}
case Some(versionInfo) => {
val currentVerStr = versionInfo.string // version info from the version.sbt file
// TODO: rename the template-config.py to config.py.
// ReadTheDocs will search the site for a config.py. If it finds one, it assumes it should be used to generate the site. So we can't leave an 'extra' config.py around, even if it's supposed to be a template file

def isPyFile(f: File): Boolean = f.getName.endsWith(".py")
//def isRstFile(f: File): Boolean = f.getName.endsWith(".rst") // not really needed, but here for symmetry
Expand All @@ -283,6 +285,7 @@ def generateSphinxConfigAction(state: State): State = {

// run the preprocess task so that it will the settings we modified above
val (newState2, result) = Project.extract(newState).runTask(preprocess in Preprocess, newState)
// TODO: rename the config.py back to template-config.py
newState2
}
}
Expand Down

0 comments on commit bcf0815

Please sign in to comment.