documentation — все вопросы

1ответ
10 голосов
Python-Sphinx: как документировать один файл с функциями?
У меня есть файл Python с функциями (lib.py), без классов. Каждая функция имеет следующий стиль: def fnc1(a,b,c): ''' This fonction does something. :param a: lalala :type a: str
1ответ
10 голосов
Неразрешенная ссылка на сборку с замком из песка
Я пытаюсь сгенерировать документацию с помощью конструктора файлов справки sandcastle. При создании проекта в замке из песка я получаю следующую ошибку. MRefBuilder : error : Unresolved assembly r
1ответ
11 голосов
Список функций на главной странице с Doxygen
Я уверен, что где-то уже об этом спрашивали, но, похоже, я не могу его найти, так что вот оно. Я создаю программу на C и использую Doxygen для генерации документации. Я вполне удовлетворен резуль
2ответа
11 голосов
Как документировать приложение AngularJS + Ruby on Rails? [закрыто]
Я использую ярд для генерации моей документации для приложений Rails из файла rdoc. Существуют генераторы документации AngularJS, но как их соединить, чтобы создать один связный документ для приложен
3ответа
11 голосов
Как Haskell справляется с документацией?
Как я могу получить онлайн документацию в Haskell? Есть ли что-нибудь столь же элегантное /удобное, как то, что Python делает ниже? >>> help([].count) Help on built-in function count:
3ответа
12 голосов
Кто-нибудь знает хороший редактор MAML [закрыто]
На работе мы используем Sandcastle для создания файлов справки. Я уже некоторое время использую SandCastleGUI и ищу способ создать дополнительные страницы в файле справки. Эти страницы написаны в фо
3ответа
12 голосов
Есть ли способ легко связать файл в RDoc?
Я хочу дать ссылку на документацию файла в RDoc. но единственный способ сделать это с помощью следующей разметки: configuration.rb[link:files/configuration_rb.html] Я бы хотел сделать это лучше
1ответ
13 голосов
Как создавать пользовательские директивы в Sphinx
В настоящее время я документирую API отдыха, написанный на Python. Вся документация проекта создается с использованием Sphinx, и для REST API я хотел бы создать несколько специальных директив. Напри
2ответа
13 голосов
Сфинкс сообщает о неработающих ссылках
Как при создании html-документации вы заставляете sphinx сообщать или создавать ошибку по несуществующим ссылкам? В частности, у меня есть свойства и методы в моем проекте Python, которые были уд
2ответа
13 голосов
Jazzy не работает должным образом для создания быстрой документации
Проведя некоторое исследование о том, как лучше документировать быстрый код. Я наткнулся на Джаззи и как это было просто реализовать. Поэтому я следую за разделом установки Jazzy Documentation . Я
7ответов
13 голосов
документация для STL [закрыто]
Последние несколько лет я боролся изо всех сил, чтобы не работать с C ++, поэтому я, наверное, один из очень небольшого числа людей, которым нравится системное программирование и шаблонное метапрогр
2ответа
14 голосов
Есть ли какая-нибудь хорошая документация об Apache Cassandra? [закрыто]
Я нашел много. Но какой из них лучший? И почему? Я не нашел ничего действительно полного и централизованного в одной хорошей статье или документации. По крайней мере, хорошая книга? Спасибо.
2ответа
14 голосов
Страница справки ASP.NET Web API - как показать общий тип возврата в документации
Я использую универсальный тип возврата для всех моих ответов API: public HttpStatusCode statusCode { get; set; } public string error { get; set; } public IDictionary<string, string&
3ответа
14 голосов
Есть ли «официальные» Javadocs для MySQL JDBC Connector? [закрыто]
Доступны ли javadoc для коннектора MySQL JDBC? Если так, где я могу их найти? Погуглив, я наткнулся на ссылки типа Класс MysqlDataSource . Но это тот чиновник? Я думаю, что я ищу что-то от mysql
1ответ
14 голосов
Генерация диаграмм для кода на Haskell [закрыто]
Есть ли что-то вроде помеси графмода и пикши? Мне нужна диаграмма, такая как graphmod, показывающая зависимости /отношения, но я хочу включить в диаграмму дополнительную документацию.
1ответ
14 голосов
Sphinx-apidoc в hjml-сборке django для `django.core.exceptions.AppRegistryNotReady`
Фон вопроса: Я хочу писать документы с помощью sphinx в моем проекте django и автоматически создавать документы с моими комментариями к коду django. Теперь у меня есть проект django (1.9), стр
4ответа
14 голосов
Где можно найти документацию по python-Levenshtein в Интернете? [закрыто]
Я нашел отличную библиотеку Python, реализующую функции Левенштейна (расстояние, отношение и т. д.) по адресу http: //code. google.com/p/pylevenshtein/, но проект кажется неактивным, а документацию
8ответов
16 голосов
Документирование кода при выходе из компании [закрыто]
Вчера я уволился со своего нынешнего места работы и взял на себя обязательство документировать свои проекты, чтобы я мог легко передать их. Учитывая, что мой код уже прокомментирован в соответств
2ответа
17 голосов
Пример кода .NET для провайдера идентификации SAML [закрыто]
Я хотел бы использовать SAML, чтобы авторизованные пользователи веб-сайта могли входить на другие федеративные сайты. На языке единого входа это означает, что мой сайт должен стать поставщиком удост
1ответ
17 голосов
Как получить полную документацию по PHP в автономном режиме [закрыто]
Я часто путешествую и часто не подключен к Интернету, поэтому я искал PHP документацию для Mac OSX. Я использовал официальную офлайн-документацию по PHP , но не могу найти много функции с официа
1 2 3 4 5

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132