Comments (3)
aringh
commented on May 15, 2024
I'm definitely not an expert in the area, but before starting to write documentation one might want to have a look at http://hplgit.github.io/doconce/doc/web/index.html To cite the home page "From DocOnce source you can generate LaTeX, Sphinx, HTML, IPython notebooks, Markdown, MediaWiki, and other formats."
from odl.
kohr-h
commented on May 15, 2024
Interesting! For our API doc, we have the Sphinx doc, but this seems to be suitable for more advanced usage with e.g. LaTeX. We should keep this in mind when we write something more similar to a user's guide (including math).
Regarding doc publication, I think ReadTheDocs is my favorite. GitHub supports it natively as a "service", so it should not be too hard to get it running. After all, it is their htmldoc style we already use :-)
from odl.
adler-j
commented on May 15, 2024
Added GitWash in commit ed175d1, looks quite good.
from odl.
Related Issues (20)
- fan2para
- scipy warning with BroadcastOperator and sparse matrices HOT 1
- Issue when using odl and import pytorch HOT 5
- FISTA for tomographic reconstruction HOT 6
- Do ADMM and PDHG algorithms have positivity constraints or padding?
- ImportError: cannot import name 'OperatorAsModule' from 'odl.contrib.torch' HOT 1
- Proximal of LInfty wrong? HOT 7
- pytorch autograd depreciated HOT 4
- FBP not scaled when PYFFTW_AVAILABLE is True HOT 4
- odl.tomo.backends.skimage_randon.skimage_radon_back_projector not compatible with skimage==0.19
- primal_dual_hybrid_gradient solver: why compute derivative ? HOT 1
- Reconstruct Mayo dataset - errors in importing statements
- odl.operator.operator.OpDomainError: unable to cast tensor to an element of the domain uniform_discr
- question about odl_torch.OperatorModule
- Error with compatibility with latest numpy version HOT 1
- RayTransform： ValueError: The 'astra_cuda' `impl` is not found. HOT 6
- The problem about indexing parallel2Dgeometry HOT 1
- BroadcastOperator doesn't work with scipy > 1.8.1 HOT 4
- AttributeError: module 'numpy' has no attribute 'object' HOT 3
- Python version 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 odl.