search

Starfish-develop / Starfish

Tools for Flexible Spectroscopic Inference
https://starfish.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
68 stars 22 forks source link

Updating Docs #116

Closed mileslucas closed 5 years ago

mileslucas commented 5 years ago

This change results in two major things-

  1. It incorporates all of the "intro" information from http://iancze.github.io/Starfish/ into the internal documentation

  2. It restructures the documents like so- Previous

    config
emulator
grid_tools
MCMC
model
scripts
spectrum
cookbook
example_wasp14
example_wasp14_data
example_wasp14_multi
example_wasp14_sampling

New

api/
  config
  emulator
  grid_tools
  MCMC
  model
  scripts
  spectrum
examples/
  cookbook
  example_wasp14
  example_wasp14_data
  example_wasp14_multi
  example_wasp14_sampling
mileslucas commented 5 years ago

@iancze check out https://starfish.readthedocs.io/en/develop/ and https://starfish.readthedocs.io/en/develop/intro.html# when you're satisfied we can remove the gh-pages branch.

P.S. I've updated the docs to work on master (one-liner) and have change RTD to point latest and master, so for the development code you'll have manually select from drop down in bottom left. As we reach stable versions we should tag those, and furthermore point that as latest so users can be assured the get the correct docs for the correct version.

iancze commented 5 years ago

This looks fantastic! Thanks for doing this :)

mileslucas commented 5 years ago

No problem! Thanks for letting me do it. I'll go ahead and delete the gh-pages branch and at that point we should have a much cleaner, smaller repo!

iancze commented 5 years ago

Ah, I should have mentioned it's also OK to remove the gh-pages branch too, thank!