Skip to content

Editing docs to facilitate flow #659

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.

Sign up for GitHub

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

Closed
kakirastern wants to merge 7 commits into from
Closed

Editing docs to facilitate flow #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
00df712
Updating "Page Contents" in sidebar
kakirastern Feb 15, 2019
40b6ee5
Added name to AUTHORS.rst
kakirastern Feb 15, 2019
9910e55
Minor editing of index.rst
kakirastern Feb 15, 2019
70facc6
Updating "conf.py" file to try and suppress collapsing of navigation
kakirastern Feb 15, 2019
f3cdb68
Testing some "html_theme_options" in "conf.py" file
kakirastern Feb 15, 2019
b0a17a3
Undoing the experimentation code snippets added earlier
kakirastern Feb 15, 2019
4ca03af
Experimenting with toctree option "includehidden"
kakirastern Feb 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Alphabetical list of contributors
* William Schoenell (@wschoenell)
* Sourav Singh (@souravsingh)
* Brigitta Sipocz (@bsipocz)
* Kris Stern (@kakirastern)
* Connor Stotts (@stottsco)
* Ole Streicher (@olebole)
* JVSN Reddy (@janga1997)
Expand Down
11 changes: 7 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,31 @@
CCDPROC
================

Welcome to the ccdproc documentation! Ccdproc is is an affiliated package for
the AstroPy package for basic data reductions of CCD images. The ccdproc
Welcome to the ccdproc documentation! Ccdproc is is an Astropy-affiliated
package for basic data reductions of CCD images. The ccdproc
package provides many of the necessary tools for processing of ccd images built
on a framework to provide error propagation and bad pixel tracking throughout
on a framework which provides error propagation and bad pixel tracking throughout
the reduction process.

Documentation
=============

The documentation for this package is here:
The documentation for this package is as follows:

.. toctree::
:includehidden:
:maxdepth: 2

ccdproc/install.rst

.. toctree::
:includehidden:
:maxdepth: 3

ccdproc/index.rst

.. toctree::
:includehidden:
:maxdepth: 1

authors_for_sphinx
Expand Down