Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation generation #31

Open
TheJJ opened this issue Apr 21, 2018 · 1 comment
Open

Documentation generation #31

TheJJ opened this issue Apr 21, 2018 · 1 comment
Labels
documentation involves primarily the code docs good first issue Simple thing, suitable for newcomers nice new thing ☺ adds new functionality

Comments

@TheJJ
Copy link
Member

TheJJ commented Apr 21, 2018

We could add some means of documentation format (like the python docstrings).
That would allow generation of API pages, so mod developers can use this as reference instead of looking at the nyan files.

@TheJJ TheJJ added nice new thing ☺ adds new functionality documentation involves primarily the code docs labels Apr 21, 2018
@simonsan
Copy link
Contributor

simonsan commented Sep 8, 2019

Don't know if it's the right issue to add this:

  1. Idea: Sphinx
    Developing extensions for Sphinx
    We could develop a small extension for sphinx (done in python) that lets us or everyone else create documentation directly from nyan-files.
    Examples for developing an extension can be found here.

  2. Role model: Rustdoc
    I also love the rustdoc approach. What is rustdoc? As I would propose it, it would be some kind of a tool, let's call it nyandoc for now, that you can give a path to a modpack/nyan-file and it automatically documents everything and creates a tiny html-page out of it that you can package/use as a website/or let people generate themselves at home. (this example is more openage specific though)

Approach 1 is probably easier and faster to accomplish, but has sphinx and python as a dependency, approach 2 would give us more freedom but seems more like a long-term approach.

@heinezen heinezen added the good first issue Simple thing, suitable for newcomers label Dec 23, 2020
@heinezen heinezen pinned this issue Dec 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation involves primarily the code docs good first issue Simple thing, suitable for newcomers nice new thing ☺ adds new functionality
Projects
None yet
Development

No branches or pull requests

3 participants