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

Incorporate building docs html into the package installation #158

Open
mspence2 opened this issue Apr 6, 2020 · 1 comment
Open

Incorporate building docs html into the package installation #158

mspence2 opened this issue Apr 6, 2020 · 1 comment
Assignees
Labels
documentation Explains how the code works or how to use it enhancement New feature or request

Comments

@mspence2
Copy link
Contributor

mspence2 commented Apr 6, 2020

The goal of this issue is to include a sphinx build process into either the setup.py file or the conda package so that the docs html file will be build upon installation instead of loading build files into the main repo.

@mspence2
Copy link
Contributor Author

mspence2 commented Apr 6, 2020

Copying Simon's latest comments on this:

"We can set things up as we want in terms of build. It is not normal to put
things that are built from a script into the repo, because a simple build
can make a huge number of files and git will track, line-by-line, all the
changes in every version of the built html files, so it makes the git db
large.

Better is to have a release script (we are using rever but we can have it
do what we want) and whenever we make the release the documents build and
are then put somewhere that is somewhat archival. In principle, the
release script could build the whole conda-pack and everything we want into
a gzip file that can then be downloaded onto flash drives....

S"

@aplymill7 aplymill7 added documentation Explains how the code works or how to use it enhancement New feature or request labels Apr 7, 2020
@aplymill7 aplymill7 added this to the v0.1.0alpha milestone Apr 9, 2020
@aplymill7 aplymill7 removed this from the v0.1.0alpha milestone Apr 16, 2020
@jlhitt1993 jlhitt1993 linked a pull request Apr 17, 2021 that will close this issue
@jlhitt1993 jlhitt1993 removed a link to a pull request Apr 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Explains how the code works or how to use it enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants