diff --git a/README.md b/README.md index 3020895..4111481 100644 --- a/README.md +++ b/README.md @@ -33,4 +33,4 @@ See `examples/mosaic.ipynb` for an example of mosaicing two images. To rerun the you will need to unzip all the zip files in the `examples/` folder. Example of mosaic from multiple images from perijove 27: -![PJ27](examples/PJ27_mosaic_RGB.png) +![PJ27](https://github.com/ramanakumars/JunoCamProjection/examples/PJ27_mosaic_RGB.png) diff --git a/docs/requirements.txt b/docs/requirements.txt index de1f03d..53db85a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,3 +12,4 @@ nbsphinx sphinx-rtd-theme ipykernel lxml_html_clean +sphinx-mdinclude diff --git a/docs/source/conf.py b/docs/source/conf.py index 0a1f6fd..ffcdee9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -47,6 +47,7 @@ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.githubpages', + 'sphinx_mdinclude', 'nbsphinx' ] diff --git a/docs/source/index.rst b/docs/source/index.rst index 174d543..a7e9b2a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to JunoCamProjection's documentation! -============================================= +Welcome to documentation for the JunoCam projection pipeline! +============================================================= The documentation will walk through the main pipeline to project individual images from JunoCam and stack them to create a full globe mosaic. @@ -19,4 +19,4 @@ a walkthrough on the projection pipeline. Projecting a JunoCam Image Projection module - README <../../README.md> + README diff --git a/docs/source/readme_link.rst b/docs/source/readme_link.rst index 57de865..3bd447c 100644 --- a/docs/source/readme_link.rst +++ b/docs/source/readme_link.rst @@ -1 +1 @@ -.. mdinclude:: ../../README.md \ No newline at end of file +.. mdinclude:: ../../README.md