What is the tool for generating and centralized storage of source code documentation?

N

Nikita Maksimov2020-11-13 22:24:54

PHP

Nikita Maksimov, 2020-11-13 22:24:54

Then in the evening I had the idea to combine all the documentation on projects that are maintained in our organization into a single database and form a small website based on it with the display of this information, convenient search and examples.

At the moment, we form the documentation through PhpDocumentor and store it next to the source code. This option is no longer suitable.

The nuance is that the system must work locally without access to the outside.

Who faced such or similar task? Maybe there is a sensible tool in the open spaces?

Reply

Answer the question

In order to leave comments, you need to log in

2 answer(s)

N

Nadim Zakirov, 2020-11-13
@zkrvndm

Saw the site, at least on the same Bitrix and host it locally. You can even write it to a USB flash drive if you wish and then always carry it with you:
https://usbwebserver.yura.mk.ua/ru.php

I

Ilya S, 2020-11-14
@Stalinko

I advise you to look towards Swagger and ReDoc.
In short:
you write all the documentation in one json file in the Swagger-OpenAPI format.
Then you write a short html that hooks up ReDoc and feeds your json to it. Further, it all turns into beautiful docks. html example:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>My API</title>
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="robots" content="noindex,nofollow" />
    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
    <style>
        body {
            margin: 0;
            padding: 0;
        }
    </style>
</head>
<body>
<script>
    <redoc spec-url="my-api.json"></redoc>
</script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js"> </script>
</body>
</html>