Comments (3)
I think it is good to have the API docs produced.
- What kind of overhaul do you think they need? It's not clear from your comments above.
- I've seen updated Doxygen templates that produce more nicely formatted API docs
from cyclus.
I apologize, I made this issue without fully exploring the API docs. I never realized that we had this thorough of API documentation, it looks like it could be really helpful.
- The "Main Page" and the "Related Pages" are pretty bare, can we make it more user friendly from that standpoint and point users in the right direction when they land on the page?
- How is this site updated? I haven't been able to find anything in
cyclus/cyclus
orcyclus/cyclus.github.com
that points to publishing these docs. I am aware that it is a target in theMakefile
if you build withdoxygen
in your environment.
from cyclus.
I think it gets built (can be built? Should be built?) as part of cyclus and deployed to that repo's gh-pages
branch that is then published as: cyclus.github.io/cyclus which should also resolve as fuel cycle.org/cyclus
from cyclus.
Related Issues (20)
- No way to print out the full composition of a material to screen
- Cleanup compiler warnings
- Use `-` and `_` consistently in `install.py` flags
- `cyclus_large` constant HOT 6
- Explicit Inventory does not pass relax-ng validation error HOT 1
- Use of packaging by supplier can result in trades not succeeding when requester accepts less than bid amount
- Material Sell Policy assumes a resource buffer is full of materials of the same composition
- `ResourceBuff` is deprecated
- GTest is included in Coveralls Report
- Review whether to store `Package` name or `Ptr`
- Sometimes resources are fully packaged, leaving a resource of zero quantity that gets recorded in the database
- Cannot find libexpat.so.1 HOT 2
- Support Ubuntu 24.04 LTS
- Complex interactions between `Package` strategies, `TransportUnit` strategies and the DRE
- Attempting to package a large quantity into small packages can throw vector length error HOT 4
- XInclude on Ubuntu 24.04
- `exclusive_orders_only` is deprecated HOT 1
- Use of fmod in material sell policy packaging process causes can result in extra full bid
- Streamline code/logic for determining the number of possible packages
- Package R-NG schema requires all elements HOT 1
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 cyclus.