documentation-generation Questions
9
Solved
Is there a way to write "standard" comments in a Makefile to later feed them to a Doxygen-like program so as to output a nice (HTML or man for instance) documentation ? I'd like to have a clear ove...
Horus asked 17/1, 2012 at 2:40
2
Solved
I just started using Docfx and set up some basic conceptual documentation. Now I want to make some adjustments to the theme (company logo, perhaps some font changes, etc.) Minor stuff.
The officia...
Animal asked 17/3, 2016 at 16:23
1
I have a project with a Nest.js API and an Angular SPA. The DTOs used by the SPA to communicate with the API are in a separate project called Models and I'm using it as a dependency. In that way, I...
Carditis asked 6/5, 2020 at 22:26
5
Solved
I'm trying to create a document out of my module. I used pydoc from the command-line in Windows 7 using Python 3.2.3:
python "<path_to_pydoc_>\pydoc.py" -w myModule
This led to my shell be...
Robi asked 23/10, 2012 at 23:2
2
Solved
I'm looking for a FREE tool which allows to generate documentation for the DB schema, tables, column, keys, indices as a PDF or HTML format like the "Toad Data Modeler" which is a commecial t...
Septuplet asked 12/6, 2013 at 15:19
7
Solved
When I generate Doxygen documentation in PDF format, I get plenty of different files with a single diagram in each.
Is it possible to obtain a single PDF document, organized as a book, roughly as t...
Masticate asked 4/11, 2010 at 17:45
1
I'm relatively new to using Sphinx and I've encountered an issue that I'm struggling to solve. I suspect the error might be related to the version of Sphinx I'm using, but attempts to resolve it wi...
Bayne asked 9/10, 2023 at 8:3
5
Solved
I want to color classes in my class diagram, based on a certain criteria, and then display a legend, that would look roughly like:
If I could add an HTML table within PlantUML's legend and endle...
Weston asked 23/6, 2015 at 9:43
3
Solved
Does gRPC support generating documentation for services like Swagger?
Immigrate asked 4/8, 2015 at 21:6
13
Solved
Many languages support documentation comments to allow a generator (like javadoc or doxygen) to generate code documentation by parsing that same code.
Does Swift have any type documentation commen...
Mills asked 4/6, 2014 at 21:34
9
Solved
How to document methods with parameters using Python's documentation strings?
PEP 257 gives this example:
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword argume...
Mcclary asked 8/2, 2012 at 14:41
3
Solved
I'm trying to clean up my python code documentation, and decided to use sphinx-doc because it looks good. I like how I can reference other classes and methods with tags like:
:class:`mymodule.MyCl...
Daylong asked 2/3, 2012 at 13:59
3
I'm building an API with django-rest-framework and I started using django-rest-swagger for documentation.
I have a nested serializer with some read_only fields, like this:
# this is the nested ser...
Emelinaemeline asked 27/4, 2015 at 16:24
0
I'm currently deciding whether to migrate my developer docs from Sphinx to Docusaurus. The one thing that's holding me back is that Docusaurus (and in fact Markdown in general) doesn't support pull...
Allsopp asked 15/8, 2022 at 10:36
3
Solved
I am trying to create a typescript doc-generator, but to do so, i need to parse a typescript file into something more easily readable
EX:
"Command": {
"description": "A command object for the co...
Emelda asked 29/8, 2017 at 12:50
6
Solved
I have a few questions about Swift documentation comments:
Is there a way to make a Related declarations section like some of the Apple documentation has? For example, when I Option+Click the tab...
Bosket asked 31/12, 2014 at 3:57
2
Solved
I have some module-level variables that have long and uninteresting values which I would like to exclude from auto-generated documentation. Is there a way to do this?
For example, in my Python sou...
Tripe asked 24/9, 2014 at 21:27
5
Solved
In composer.json I've got
{
"require":
{
"phpdocumentor/phpdocumentor": "*"
}
}
It's what is there because I'm trying to install phpDocumentor into an isolated folder with ./composer.phar in...
Policewoman asked 24/4, 2014 at 8:44
1
I'm working in a jupyter notebook using python and trying to use the auto-documentation function to generate docstrings like below. When working in an IDE like pycharm a triple quotation + Enter un...
Rema asked 13/6, 2019 at 10:38
7
Solved
I am using the 'Automatic Generator' of GitHub Pages, and I see it only generates a single index.html and other web resources.
How it works if I want to have a multi-page website generated from ot...
Sobranje asked 24/12, 2012 at 18:23
2
Solved
I have this method which I am trying to generate documentation.
/// <summary>
/// This method demonstrates taking a Func as argument and perform that action(Func) on a list of strings.<...
Covalence asked 29/6, 2014 at 10:30
4
Solved
I'm trying to auto-generate basic documentation for my codebase using Sphinx. However, I'm having difficulty instructing Sphinx to recursively scan my files.
I have a Python codebase with a folder ...
Constrict asked 6/1, 2011 at 15:44
2
It seems that the godoc tool is not Go modules aware.
A simple godoc -goroot=. serves the project files, but it does not generate documentation for the packages. I tested it from withing the proje...
Euglena asked 28/2, 2019 at 20:44
1
I am converting my packages to use roxygen documentation, through the roxygen2 package. Now my package does not load and I think that is is because of the missing useDynLib(mypackage) call missing ...
Chak asked 6/12, 2011 at 22:13
4
I am looking for an alternative to C#'s XML source code documentation which introduced by the very nature of XML a lot of noise that is heavy on the eye and more work to write:
/// <summary>...
Volsci asked 29/7, 2014 at 9:48
1 Next >
© 2022 - 2024 — McMap. All rights reserved.