Comments (3)
If you are thinking about a general re-organization of the documentation, I would like to suggest this system which I found very helpful in my own projects. It groups documentation in four categories:
- Reference: This is helpful for experienced users who want to look up a specific syntax. The current documentation is almost exclusively written in reference style (auto-generated from docstrings)
- Explanation: This is helpful for people who want to learn the economics/numerics and syntax at the same time. This is the style of the quantecon lectures.
- Tutorials: Tutorials help newbies to discover the functionality of a package. In my experience, tutorials can increase the adoption of a package. The submitted paper is written in tutorial style, Having a notebook with all examples from the paper would be a great getting started tutorial.
- How-To Guides: How-To Guides show how to achieve a very specific task without explaining any background that is not immediately relevant. I think this is not covered in the current documentation.
A great example of documentation that uses this system is pytask
from quantecon.py.
+1
from quantecon.py.
thanks @janosg -- nice suggestion.
from quantecon.py.
Related Issues (20)
- Unify QuantEcon.py and QuantEcon.jl APIs? HOT 6
- Update Developer Contribution Guide
- Migrate Commit History? HOT 5
- Update badges on README.md
- [Bug]: Error with period of Markov Chain with custom state_values HOT 3
- Bring estimate_mc into top level namespace
- Add function fit_discrete_mc HOT 6
- Register `cartesian_nearest_index` also to `__all__` in gridtools.py? HOT 1
- DOC: Update or remove broken links to QE lectures HOT 2
- Organise a new release `v0.7` with new features HOT 1
- Missing options for tie_breaking in QuantEcon/GameTheory HOT 1
- Error Raised in `qe.random.draw`
- FIX: DOC: Fix build error with Sphinx v7.0.1 HOT 1
- Warning when importing `quantecon` package HOT 2
- License mismatch between repo and JOSS paper HOT 2
- Linprog Incorrect Outputs HOT 2
- Add examples to docstring for `linprog_simplex`
- conda releases stalled HOT 3
- Fix numba deprecation notice 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 quantecon.py.