Questions tagged [documentation]
THIS TAG IS FOR DOCUMENT GENERATORS ONLY. Include language and/or SDE tag as well. DO NOT USE to ask for links to documentation or tools, or to critique vendor documentation.
documentation
4,684 questions
Advice
5
votes
1
replies
75
views
How to programmatically find pkgdown/altdoc documentation URLs for R packages?
I'm building a reference guide, R Functions for Categorical Data Analysis, https://friendly.github.io/psy6136/R-functions.html, that lists R functions for analysis and visualization, organized around ...
- 4,083
Advice
0
votes
2
replies
63
views
Are Kafka Heartbeat messages running on independent thread or are they linked to consumer poll and commit?
Is Kafka consumer heartbeat message same as consumer poll and commit? Or does it run on a separate thread and keeps sending heartbeat to Kafka broker as long as the consumer JVM is responding?
The ...
- 509
0
votes
0
answers
97
views
Wikipedia returns 403 when using sphinx linkcheck to check for broken links
We use sphinx linkcheck to make sure that our docs do not contain broken links, but Wikipedia has started returning a 403, assuming that our CI is a robot. Fair enough, it is a robot, so has anyone ...
- 1,278
Tooling
0
votes
3
replies
52
views
How to configure IntelliJ IDEA to include parameter and return types in auto-generated JavaDoc?
Is there a way to make Intellij add the types of the parameters and the return values in its auto-generated java documentation?
My desired documentation format would look like this:
...
- 475
Tooling
1
vote
0
replies
38
views
Use a json body as point of reference for documentation
I am looking to move away from Excel spreadsheets. I want my json body to be the point of reference for mapping UI entry field, Database table.name.field, data exchange etc. Does this make sense?
- 21
Advice
0
votes
5
replies
48
views
Generating Interactive Documentation from Javascript Source Code
I’m working on an Electron project, and I can generate JSON for my code using JSDoc:
jsdoc -X > data.json
I want to use this JSON output to create a live, ...
- 56
0
votes
0
answers
44
views
How does the GJS documentation pipeline work with DevDocs?
I’ve noticed that GJS documentation uses DevDocs.
I’m trying to understand the documentation pipeline for GJS:
Does it read comments from the source code and generate documentation automatically?
Do ...
- 56
0
votes
0
answers
124
views
Sphinx sphinx-apidoc generated module titles are too long (full package path). How can I shorten them?
I am generating python API documentation using Sphinx and sphinx-apidoc with sphinx-rtd-theme
The problem is:
The page titles and ToC entries for modules/packages always show the full import path,
e....
- 179
0
votes
0
answers
26
views
Attach a TSDoc comment to a `export * as myModule from './my-module'`
Against ts_ls, the hover action on myModule above does not result in the documentation popping up. I've tried
...
1
vote
0
answers
73
views
Docsearch Typesense scraper only finds records on Docusaurus landing page
Problem
I’m using Docusaurus with Typesense and the docsearch-typesense-scraper to index my documentation site.
Everything runs fine — the sitemap is found, and the scraper produces records.
However, ...
- 11
0
votes
0
answers
84
views
How to show a single version dropdown per product in Docusaurus multi-product documentation?
I’m building documentation for multiple products on a single Docusaurus 3 website. Each product has its own versions, and I want users to be able to select a product first, then optionally select a ...
2
votes
1
answer
86
views
Why doesn’t Xcode show documentation for class initializers when creating an object in Swift?
I’m working with Swift and I’ve documented my class initializers using ///.
However, when I create an object with ...
- 23
0
votes
0
answers
39
views
SAML attribute for SaaS apps
I am working with Single Sign-On (SSO) using SAML for multiple SaaS applications. Each SaaS provider requires different attribute mappings (for example: email, firstName, lastName, NameID, etc.).
I ...
- 1
0
votes
1
answer
55
views
How to generate documentation for multiple files using pydoc
I tried to generate documentation for my python project using pydoc.
My repository looks like this:
main.py
src/
├─ cli.py
├─ ui.py
In the main.py file, I have ...
0
votes
1
answer
104
views
macro expand to inner attribute and inner comment
I'm trying to make some stability promises for my library. Ideally I'd like to be able to mark the top of a file as stable/unstable, and emit some things as a result.
Unstable allows unused, and is ...
- 121
0
votes
2
answers
87
views
Laravel API: PUT request with multipart/form-data returns empty request when using Swagger or Postman [duplicate]
I'm working on a Laravel 10.x project with an API that allows updating an event using a PUT /events/{id} endpoint. This endpoint accepts multipart/form-data to optionally upload an image and pdf, and ...
0
votes
0
answers
65
views
How to properly integrate cofReason and mada transaction types with Mastercard Gateway API?
I’ve been successfully integrating the Mastercard Gateway API (MPGS) using the official GitHub guide: https://github.com/scriptpapi/MPGS-Integration-Guides-and-Samples/blob/main/docs/direct.md
So far, ...
1
vote
1
answer
511
views
How to write data to a gip device (Xbox Series controller)?
I am working on a C# program that would send a power off packet to my xbox series controller in order to turn it off.
In 2024 Microsoft released GIP docs and as far as I understand Xbox One and Series ...
- 263
0
votes
1
answer
61
views
Code block partially highlighted in Sphinx
In my Sphinx documentation I have the following code-block:
.. code-block:: python
import logging
logging.getLogger('mymodule').setLevel(logging.INFO)
but ...
- 1,003
3
votes
1
answer
156
views
Why add redundant `std::constructible_from<T>` to the concept `std::default_initializable`?
At the cppref page on the concept std::default_initializable, I saw the following code:
...
- 44.7k
0
votes
0
answers
38
views
Can I label a method in Scaladoc and then link to its documentation?
Linking to overloaded methods is a nightmare, especially since it is typical for argument lists to have common prefixes. Ugly, bug prone, brittle, and current IDEs aren't able to process such ...
- 2,311
0
votes
1
answer
132
views
How should I document Python constants so they are reflected in Intellisense and Sphinx?
I have a file called constants.py where I store all my constants, such as paths PATH_DATASETS = "data/datasets/" or values ...
- 1
0
votes
1
answer
200
views
Create documentation in Backstage that is not associated with a component
I was wondering if there is some way of creating documentation in Backstage without a component. I would like to create documentation that appears in the Documentation option displayed in the sidebar ...
- 379
2
votes
1
answer
86
views
ASP.NET XML Docs with implied 'summary' tag
I want my ASP.NET (C#) project to show the XML docs comments in Swagger UI. This is working but I also want there to be an implicit <summary> tag on my ...
- 3,495
0
votes
0
answers
33
views
ToC lists subsections for Python but not for MatLab Code
I am testing Sphinx to help documenting MatLab (and Python sometimes) code using the comments. After a lot of struggling, I managed to get both working but noticed that I don't get sub-levels on the ...
- 21
3
votes
1
answer
164
views
Sphinx - autodoc imported data with own docstring
The situation
I want to use the Sphinx autodoc features to document a Python API that is implemented in the following way.
I have a module that is used to expose various symbols (functions, constants, ...
- 90
1
vote
0
answers
68
views
Inheriting constructor documentation in JSDoc with ES6 classes
I am writing documentation for some classes written using the ES6 class syntax. I have some classes which inherit their constructor from their parent class, as below:
...
- 113
0
votes
0
answers
62
views
Sphinx can't see function inside of my class when it builds
I have a project with this structure:
...
-2
votes
1
answer
110
views
Best practice for code snippet in doc comment for C project? [closed]
I'm familiar with Rust, and recently I'm going to write a C project. In Rust, we usually embed some code snippets as usage examples directly in the doc comment. However, I found this hard to be ...
- 1,225
0
votes
0
answers
29
views
How to document input and output fields in Postman collection?
I have a Postman that I have to document, I found the document page but it seems to let me add just some descriptions.
Let's say this is a REST API service with json input, is there any way to ...
- 9,667
3
votes
0
answers
108
views
Can Doxygen generate architecture documentation from C code?
When approaching a new code, even for embedded software written in C, it is common to face a large number of big files, with no/scarce/wrong comments.
In this situation, to have a basic understanding ...
- 87
0
votes
0
answers
55
views
Doxygen hide compound reference for Namespace
The following option in the Doxyfile can be used to hide the trailing "Class Reference" text from a page title.
...
- 61
0
votes
1
answer
235
views
How to replace the deprecated plugin function with the apply function in Gradle
The Android Studio's Empty Activity default configuration calls the plugin function in two ...
- 3
-1
votes
1
answer
104
views
Google Vision AI does not include correct documentation [closed]
I am using the following code to do OCR using Google Vision AI:
...
- 33.8k
0
votes
0
answers
43
views
Is there a way to generate 'File List' in Sphinx for Python?
Is there a way to generate "File lists" in Sphinx documentation for a Python repository similar to Doxygen File lists generated for C++ as shown below?
Doxygen File lists
I've tried the '...
- 1
1
vote
2
answers
713
views
How do I use CLion TIP comment style documentation?
When I was learning C++ using JetBrains CLion IDE, I noticed there are comments in the code that looks different from Ctrl + / comments. Those comments have a pen and book gutter icon (documentation).
...
0
votes
0
answers
103
views
YARD documentation in RBS
Background
I have some methods i added to String programmatically and I want to document those for code completion and generated docs. I started with just YARD’s @!method and wanted to write also type ...
- 26.5k
1
vote
1
answer
114
views
Sphinx "only" directive with lists?
When using reStructuredText in Sphinx, how can I have optional list items using the only directive?
As an example:
...
- 782
0
votes
0
answers
31
views
Show function definition on class page and topic page
Is is possible to set up Doxygen so that the detailed function definition blocks are shown on both class and topic pages?
Say I had the following class, with Doxygen comments above the method ...
- 61
1
vote
0
answers
86
views
Doxygen link to Topics page
How does one link to an auto-generated Doxygen page such as Topics or Namespaces? Typically, I would link to a page by defining ...
- 61
2
votes
0
answers
53
views
How to get sphinx to autodoc "items" attribute in TypedDict?
I have a custom type defined as follows:
custom_type.py
...
- 21
-1
votes
1
answer
42
views
Insufficient information about jStat functions in the documentation
While writing a JS application for performing a pairwise Tukey test, I encountered an issue with the function jStat.ttest()
I described my experience below.
However, in addition I would very much like ...
8
votes
3
answers
2k
views
Task ijDownloadSources not found in project app
I can't download documentation for most of all classes.
For example:
I'm using class ActivityResultContracts and when I move cursor on class name or on method in ...
- 183
2
votes
0
answers
43
views
How work the limited parallelism in node.js
I'm reading the node.js documentation, and I don't understand the explanation of the asynchronous flow: https://nodejs.org/en/learn/asynchronous-work/asynchronous-flow-control.
Indeed, the last ...
- 121
1
vote
0
answers
42
views
repository with Multiple adrs
We currently work on job that stretches out over month. Every time I look at the code, I see a lot of code and in don’t remember what decision lead to that code.
there is a solution for that problem ...
1
vote
1
answer
73
views
C# XML documentation: dealing with the entirety
In recent times I annotated my entire large C# project with XML documentation, and I also made heavy use of the inheritdoc notation (for example when we are overriding a base class method).
Imagine my ...
- 343
1
vote
1
answer
365
views
Use of `--upgrade` option in DBT 1.7 - `dbt deps` for package-lock.yml
I am trying to understand the introduction of package-lock.yml in the DBT Documentation for Upgrading to 1.7
However, it is not quite clear how ...
- 529
1
vote
0
answers
48
views
Swagger API documentation, define array in url
Following the documentation of Swagger I've been able to document most of my API. The one I'm stuck on seems to be an array in the GET url.
What this generates is:
...
- 1,131
1
vote
1
answer
138
views
How to receive Enum as String in a Dotnet API?
I have a dotnet API application documented with swagger. In one of my end-points I receive a DTO like this:
...
0
votes
0
answers
117
views
.NET / C#: How to ignore GenerateDocumentationFile for source generated .g.cs files by packages
My .csproj file uses
<GenerateDocumentationFile>true</GenerateDocumentationFile>
to indicate that we will be auto-...
- 125