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.

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

DOC: adding generic documentation to the HTML rendering #210

Merged
merged 4 commits into from
Mar 11, 2024
Merged

DOC: adding generic documentation to the HTML rendering #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
159ad67
DOC: adding Fornax Console documentation to the site
bsipocz Jan 10, 2024
40ef3c8
DOC: cloning documentation repo for rendering
bsipocz Jan 11, 2024
f5fcce8
CSS: remove launch buttons
bsipocz Jan 12, 2024
101f0fa
DOC: changing heading texts
bsipocz Jan 12, 2024
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
5 changes: 0 additions & 5 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,6 @@
"use_repository_button": True,
"use_issues_button": True,
"use_edit_page_button": True,
"launch_buttons": {
"binderhub_url": "https://mybinder.org",
"colab_url": "https://colab.research.google.com"

},
"home_page_in_toc": True,
# "logo_link_url": "https://astroML.org",
# "logo_url": "http://www.astroml.org/_images/plot_moving_objects_1.png"
Expand Down
13 changes: 12 additions & 1 deletion index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Table of Content
# Tutorial Notebooks

```{toctree}
---
Expand All @@ -15,3 +15,14 @@ light_curves/README
```{include} README.md

```

## Documentation

```{toctree}
---
maxdepth: 2
---

documentation/README

```
1 change: 1 addition & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ allowlist_externals = bash
commands =
pip freeze

buildhtml: git clone --depth 1 https://github.com/fornax-navo/fornax-documentation.git documentation
buildhtml: sphinx-build -b html . _build/html -D nb_execution_mode=off -nT --keep-going

skip_install = true