Comments (5)
fmaussion
commented on July 17, 2024
1
Sphinx will parse the python files, so what you need to do is document the classes properly (see e.g. the GlacierDirectory class in OGGM) and sphinx displays it:
- https://github.com/OGGM/oggm/blob/a0c8857a3420fb652b93039ce0a28ebe2b996c19/oggm/utils/_workflow.py#L2353
- https://docs.oggm.org/en/latest/generated/oggm.GlacierDirectory.html
from oggm-edu.
fmaussion
commented on July 17, 2024
Yes. Its actually relatively little work if your classes are well documented.
from oggm-edu.
fmaussion
commented on July 17, 2024
As a first step you just need to add an API page to the oggm-edu sphinx page like OGGM
from oggm-edu.
Holmgren825
commented on July 17, 2024
Nice, I will investigate.
from oggm-edu.
fmaussion
commented on July 17, 2024
https://github.com/OGGM/oggm/blob/master/docs/api.rst
from oggm-edu.
Related Issues (20)
- Simulator page formatting
- Add some links
- Google gives oggm-edu link that does not work HOT 1
- "Open in new tab" for certain links
- Remove baseline images HOT 1
- Non-linear bed profiles
- Indicate glacier type in the collection
- Check that the notebook still work after the API changes from the doc PR HOT 5
- Translate the most important pages HOT 3
- Convert class activites to RST and tranlaste them to German
- Who are the "future improvements" sections for? HOT 2
- Translate Glacier Simulator experiments into SERC-documented activities HOT 1
- Translate MB Simulator experiments into SERC-documented activities
- Move `oggm-edu python package` page to its own subheader at bottom of sidebar HOT 1
- Docker Link of glacier simulator is not working HOT 5
- Update Thumbnails of Glacier Explorer and Simulator
- Indicate for who the materials are
- Builds are failing
- Add name attribute to 'Glacier' and 'GlacierCollection' objects HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from oggm-edu.