Syntaf / travis-sphinx

A standalone script for automated building and deploying of sphinx docs via travis-ci
GNU General Public License v3.0
113 stars 20 forks source link

Default directories should be consistent between source and build #43

Closed berquist closed 6 years ago

berquist commented 6 years ago

The default top-level for building is doc, and most documentation refers to doc rather than docs. Switch everything to doc.

codecov-io commented 6 years ago

Codecov Report

Merging #43 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #43   +/-   ##
=======================================
  Coverage   81.88%   81.88%           
=======================================
  Files           5        5           
  Lines         138      138           
=======================================
  Hits          113      113           
  Misses         25       25
Impacted Files Coverage Δ
travis_sphinx/build.py 83.33% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1082606...0c12039. Read the comment docs.

Syntaf commented 6 years ago

Thanks for the PR and sorry for the delay. I'll take a look at this when I'm home from work today

Syntaf commented 6 years ago

Is the actual default sourcedir for sphinx doc? Or is this a change made on personal opinion about the naming of mose sourcedirs?

Regardless, this introduces a breaking change into travis-sphinx, something I'm not willing to do. Existing repositories using the default doc dir would start failing after this. Having packages randomly start breaking on me is aggravating to say the least, and I don't want to be one of those packages.

I appreciate the PR however, thank you for taking the time to look into this!

berquist commented 6 years ago

Is the actual default sourcedir for sphinx doc? Or is this a change made on personal opinion about the naming of mose sourcedirs?

There is no default, since sphinx-quickstart places everything in your current working directory. I proposed the change because I was confused about how the language in the README switches between the two, and why doc and docs were appearing in my source tree, and I needed to read all the source code to understand what the default directories are.