Comments (4)
It is not clear to me how to format the docstring when using reStructuredText. jupyter is not able to make any sence of this:
def test(bla,suelz):
"""something
:param bla: info
:param suelz: info
:type bla: float
:type suelz: int
"""
return 'huhu'
from atm-py.
do you know of a good example project on github that uses reStructuredText.
from atm-py.
I am not following this. We are not talking about notebooks, are we? Notebooks are used for gists, personal work, demonstations, etc. Why is this an issue?
As far as examples go - scipy, numpy, ALL OF PYTHON.
From Python Guide:
A README file at the root directory should give general information to both users and maintainers of a project. It should be raw text or written in some very easy to read markup, such as reStructuredText or Markdown. It should contain a few lines explaining the purpose of the project or library (without assuming the user knows anything about the project), the URL of the main source for the software, and some basic credit information. This file is the main entry point for readers of the code.
From the python docs:
The Python language has a substantial body of documentation, much of it contributed by various authors. The markup used for the Python documentation is reStructuredText, developed by the docutils project, amended by custom directives and using a toolset named Sphinx to post-process the HTML output.
numpy and scipy use a flavor of it. Django uses it. And I am pretty sure most every library uses some form of it. Look at how these use it, but the fact that it is recommended by the Python Software Foundation seems sufficient to me.
There is a post on reddit discussing just this issue. I don't think that we should worry about this though as the best case scenario is that we are able to produce documentation that can be extracted and presented as PDF or HTML. We can do this with rst.
Do you have an alternative proposal?
from atm-py.
No, sounds great to me.
I am asking because I assume that sphinx pulls in docstrings into the documentation. I am wrong about that? And I was afraid that we have to use the syntax i posted further up, which is kinda hard to read.
from atm-py.
Related Issues (11)
- what is the folder "/__pycache__" good for?
- clean up that mess HOT 51
- Mie code HOT 9
- Moving water saturation out of atmosphere.py HOT 1
- Adding density calculation for gases to ``Gas`` object
- Add unit tests HOT 2
- Need solid naming conventions HOT 6
- Using external libraries HOT 11
- Proposal for sampling efficiency HOT 1
- Builds failing due to poor travis-ci support HOT 2
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 atm-py.