Comments (10)
Ok, first step is to select a more attractive theme. Probably this can be done using the readthedocs config options. Let's see.
https://readthedocs.org/projects/rtd-sphinx-theme-sample-project/
- lastest
- nature
To change the theme:
https://docs.readthedocs.io/en/rel/theme.html
from mcthings.
Ok, cool. Now, we need that the README.md is included in land page of readthedocs. And for it, we need to convert it to rst during the doc generation.
from mcthings.
To include the README.md contents:
https://zj-zhang.github.io/2019/02/24/use_sphinx/
from mcthings.
There is an issue with m2r now:
from mcthings.
When having issues the best reference is: https://docs.readthedocs.io/en/stable/faq.html
from mcthings.
from mcthings.
It is not easy to make Markdown appears right on readthedocs:
https://www.sphinx-doc.org/en/master/usage/markdown.html
Ok, I can convert my markdown pages to rst but the results are just horrible:
So I think I am going to stop trying to include the md files in readthedocs.
It seems that the problem is just with URL links.
from mcthings.
Ok, so in readthedocs there is also the code documentation to use the library.
from mcthings.
If we want to have all the doc in readthedocs the approach seems to be to use rst format to create the doc. GitHub supports it.
For example, it is the way used by https://minecraft-stuff.readthedocs.io/en/latest/index.html
from mcthings.
Taking a look to other projects with nice doc like:
https://bootstrap-datepicker.readthedocs.io/en/master/
they have specific doc in rst format for it.
https://github.com/uxsolutions/bootstrap-datepicker/blob/master/docs/index.rst
Too much effort for the current state of McThings!
from mcthings.
Related Issues (20)
- Learn Vulcan API HOT 3
- Research Open Source Physics engines HOT 5
- Learn Computer Graphics HOT 1
- Research Ray Tracing HOT 11
- Explore the Cyrille Rossant Python Ray Tracer HOT 4
- Implement a Ray Cast renderer for McThings
- Test that McThings works with MC 1.16.1 HOT 2
- Create a Blender renderer for McThings
- Remove McDrawing reimplementing the Sphere
- Research resources pack in Minecraft HOT 4
- Research shaders in Minecraft HOT 1
- Research the use of textures inside Blender
- Research the use of shaders inside Blender
- Implement voxels collisions in Godot physics testbed HOT 14
- Create a Godot renderer for McThings
- vox2schematic - TypeError: to_nbt() takes 3 positional arguments but 4 were given HOT 1
- Test McThings with the last version of Minecraft HOT 2
- Research the migration from TravisCI to GitHub Actions HOT 1
- vox2schematic not working
- Implement McThings over Godot
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 mcthings.