860 questions
0
votes
0
answers
50
views
How can I get remotes::install_*() to build my package documentation with roxygen2?
I am writing an R package that I install on our server using remotes::install_git(). The package manual pages (man/*.Rd) are not tracked in git, but are generated using roxygen2. When I run remotes::...
- 42.4k
0
votes
1
answer
58
views
How to format Jenkins shared library docs
I have successfull build a Jenkins Shared library.
In the vars folder are
lbrCall.groovy
lbrCall.txt
I am missing something on formatting the documenatation of the lbrCall.txt.
The documentation in ...
- 664
1
vote
1
answer
59
views
Pandoc HTML Reader , Read <title> tag , as a pandoc Object Header?
I am doing a Custom Parser for different documentation stored in .html .
I am interested on parsing the <title> tag of the documents, but it seems that the default pandoc Reader for HTML doesn't ...
- 168
-1
votes
1
answer
53
views
How to parse a java class located in an external library?
Im currently developing a plugin which can create a markdown table from an enum.
For example if i have this enum:
enum MyEnum {
/**
* Documentation for 1
*/
MYCONSTANT1(1),
MYCONSTANT2(2);
...
- 73
0
votes
0
answers
406
views
Dealing with extremely strict OpenAPI/Swagger interpreter's vague error messages
I have an API that a client is trying to use and they need Swagger documentation for it. They take it and upload it into a very strict interpreter that gives unhelpful error messages and I'm not sure ...
- 337
0
votes
1
answer
122
views
Exclude decorators in pdoc documentation
I would like to exclude decorators from my API documentation using pdoc. Is there any possible way I can achieve that?
For an example, if I write:
@xl_func("blah", "blah")
def ...
- 444
0
votes
1
answer
90
views
Sphinx autoflask only makes one page for all the endpoints
I've inherited a project and am using Sphinx for the first time.
I've got a app.py that has all my api endpoints and when you make documentation you have all the api.add_resources wrapped in a ...
- 40
0
votes
0
answers
24
views
Visual Studio Code - Typing /// does not autogenerate "summary" [duplicate]
On a new computer so I had to fresh install everything. In the past, when I typed "///" before a method, VS code would autogenerate a "summary" block that I could fill in with ...
- 23
0
votes
0
answers
55
views
Why do class names appear in my Doxygen namespaces list?
I'm working on sprucing up the generated documentation for a C++ library of mine, using doxygen (the master branch HEAD as of right now, v1.11.0). After generation, and looking at the Namespaces page, ...
- 137k
0
votes
1
answer
98
views
Creating a Modular Definition List using DITA
TLDR; I want to make a concise list of modular definitions using DITA OT transforming to PDF
Hi, I'm an indie developer trying to learn how to make good user documentation. I want it to be modular and ...
1
vote
0
answers
196
views
how can i Automate documentation in my CI/CD pipeline or through my project workflow (java) ? documentation generator for the whole process?
Currently i am writting the documentation of my project Manually , it's hard and time consuming i want a solution that help me to generate documentation automatically is there any plugins or tools or ...
- 23
0
votes
1
answer
66
views
Is there a way to generate asciidocs from application.properties in Quarkus?
Is there a way to automatically generate asciidocs from application.properties in Quarkus?
lets say i have an application.properties with the following keys
quarkus.lambda.expected-exceptions
quarkus....
0
votes
1
answer
43
views
is it possible to generate documentation for anonymous classes in rdoc
I would like to document a few methods in an anonymous class for rdoc.
I know that alternative documetation tool exists, such as yard, but not sure the project owners are ready for change they ...
- 3,845
0
votes
0
answers
18
views
I can't put text like [static] on the right side of the page for a certain function in doxygen
What is the syntax to put a short test note or a tag on the right side of the page to indicate some kind of a property of a function like a nothrow or static.
see the image how Qt does it.
I could ...
- 1,180
1
vote
0
answers
1k
views
deploy project documentation to gitlab wiki using CI/CD pipeline
I'm using GitLab Community Edition v16.8.1, and I'm using Doxygen/Sphinx to generate my documentation automatically as html files, is there a neat way to automate the deployment to wiki using the CI/...
- 304
1
vote
1
answer
77
views
Jazzy: zsh: no matches found: --documentation=./*.md
I'm using jazzy and it seems to not want to include all of the markdown files in the rendered documentation pages.
For example,
jazzy --xcodebuild-arguments -scheme,MyCustomSchemeName --documentation=...
- 8,524
0
votes
0
answers
54
views
How to use roxygen2 to print documentation of self defined function?
I define a function called avglist in R and would like to print the documentation of avglist using ?avglist or help(avglist), but they both failed.
library(roxygen2)
#' Function:avglist
#'
#' ...
0
votes
0
answers
86
views
Swig-Doxygen translation lines still appear on C++ script
I am using swig to generate wrapper Python function for C++ based application. when using swig, I am using -doxygen option to translate doxygen document to python wrapper file. Inside C++ header file, ...
- 1
0
votes
1
answer
89
views
How to include publishing notes in Sphinx documentation?
I would like to include a link to our publishing notes in the footer of Spinx html outout, next to the Copyright notice.
I tried to include a link in the copyright notice in conf.py. However, that is ...
- 12.8k
1
vote
0
answers
390
views
Vue component's description for vue-docgen-api in script setup
The vue-docgen-api shows an example of component description in the "old" options style:
<script>
import { text } from './utils'
/**
* This is an example of creating a reusable grid ...
- 280
0
votes
1
answer
701
views
Dokka is not generating documentation for test package
I have KDoc style comments in my tests code and I want to generate documentation using Kotlin DSL Gradle dokkaHtml tasks. But after successfully executing the task it says "Exiting Generation: ...
- 3
0
votes
1
answer
829
views
How to make Typedoc grab TSDoc comments inside of a type definition
i'm working on the implementation of typedoc in my company's codebase and i'm stuck on an issue.
/**
* The tuples and levels corresponding to the selected positions (which can be headers in a table ...
- 43
1
vote
0
answers
33
views
How Python's "Changed in version" statements are generated?
I'm curios how the "Changed in version" statements are generated in Python's docs.
Consider the documentation for namedtuple:
Changed in version 3.1: Added support for rename.
Changed in ...
- 185
2
votes
0
answers
234
views
Sphinx usage with Matlab does not generate documentation (sphinxcontrib.matlab)
I am currently developing a MATLAB toolbox as part of my bachelors at TUM, that I would like to document using the automatic documentation in Sphinx.
There is a extension available for just that here. ...
- 21
0
votes
1
answer
2k
views
Generate documentation for python functions in a jupyter notebook using docstrings
There is a Jupyter Notebook with multiple python functions with docstrings. Is there a way to generate documentation for those functions without converting the notebook into a Python script?
Usually, ...
- 143