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

write documentation in rst #10

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

12rambau
Copy link

@12rambau 12rambau commented Nov 20, 2021

We have build documentation for the SEPAL platform and BFAST explorer is one of the (many) application that we provide to our users.

The documentation is buid using sphinx so I needed .rst file to parse it with the other. That would have been to complicated to parse it again so I wrote a separated .rst.

  • Using "Bfast explorer" as a main title
  • using substitution rules for the inlin icons
  • using note admonition to replace the htm text
  • using thumbnail to display images (as the doc is created elswhere I used absolute path to image instead of the .md relative path)
    doc.sepal.io is currently point ing to my fork of your repository but I woudl be happy to point to yours if you accept my PR !

https://docs.sepal.io/en/latest/modules/dwn/bfast_explorer.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant