# Tag Info

14

You can do this with the normal Microsoft C# compiler. Though it isn't open source. Debately it is free, since it uses tools you already have. For C# file called XMLsample.cs csc XMLsample.cs /doc:XMLsample.xml will produce xml file XMLsample.xml. By applying a style-sheet to this, you'll have nice website. CSS should do, though for more significant ...

14

Doxygen seems like what would work for you. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation ...

11

After searching and trying for a while, I found a perfect alternative to it. DocFX Main Features: Website from Source Code DocFX generates API documentation directly from .NET source code. You can use Markdown syntax in the Triple-Slash-Comments in source code. It even allows you to add additional topics to the API documentation using Markdown files. Of ...

7

Personally I would strongly recommend taking a look at Sphinx-Doc which was written for the Python documentation but is applicable to other systems as well. Produces great looking documents with multiple themes in multiple formats Can generate from multiple programming language, e.g. C++ with the C++ domain Can be integrated with build systems including ...

5

Putting in my 2c because I was following the accepted answer, but it turns out, Microsoft C# compiler is only doing a half-baked job. I.e., it only gives you an xml file. But to have a nice website, you'll still have to apply some style-sheet to it, and that's where the bridge is broken -- Microsoft C# compiler doesn't do that, and the Microsoft supported ...

4

I can think of a few options for you: Self Contained Binaries Portable Python - You would probably need to pick one of the document generators above, or possibly Sphinx, and add it to your portable python "installation". Pandoc built as a relocatable binary as explained here. Both of the above meet the requirement of: It runs on offline hosts It runs on ...

4

You, sir, are looking for GitHub Wikis.

3

Doxygen Doxygen is a general purpose code documentation tool. It supports Markdown starting from version 1.8.0, and it can generate static HTML files among many other formats. Features: Cross-platform. Runs on all versions of Windows since XP Has a portable installation that you could bundle with your repository so it would run offline and without ...

3

I can strongly recommend Sphinx Document generator - for an example site take a look at the new wxPython documentation. Generates documentation from: Python code C/C++ code reStructuredText3 Multiple output formats - HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text Code Highlighting for a wide ...

2

We use Document! X and it works really well for us. You get the full API docs from the comments and the style sheets for it make it look very very nice. They're also really responsive on support. With that said, it's not free. But for what it delivers, I think it's well worth it. (We previously used a free program, not doxygen, and that ended up being too ...

2

I would highly recommend http://phpfui.com for this. Runs as a PHP script right on your server. Will produce static files if you need them for high volume sites. Easy to install and set up. Maybe 2 minutes to usable documentation for your code and all the third party code you use in your app.

2

Personally I can strongly recommend Sphinx Document Generator: Free, Gratis & Open Source Cross platform One set of base files, in ReStructuredText format which are easily version controllable. Simple inclusion of screenshots, etc. Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain ...

2

Sandcastle Help File Builder supports .NET Core projects as of the v2017.5.15.0 release. Release notes for version 2017.5.15.0 ... A new cross-platform reflection data set file (CrossPlatform.reflection) was added. This is the preferred framework version setting to use for all .NETCore and .NETStandard assemblies and projects that you ...

2

(I've salvaged several answers from the now-deleted StackOverflow question page:) Doc++ You could try DOC++ but it may be even uglier. cldoc There is an open source alternative to doxygen out there called cldoc. It can handle both C and C++ and is based on clang. The most interesting features it claims to offer: Uses clang to robustly parse even the ...

2

Syncfusion Essential PDF Viewer for ASP.NET/ASP.NET MVC is an option to consider. This will allow you to display the generated PDF in a consistent manner irrespective of the PDF Viewer the user has. Online sample browser It will also be helpful to review how you are generating the PDF as that might be the cause for the PDF not being displayed properly in ...

1

Lately I've been seeing Read the Docs being used in a lot of (OS) projects. As far as I can tell it's mainly aimed at code documentation, not sure if that fits your need. Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and ...

1

Libre Offfice's "writer" will let you generate both to HTML and PDF. When the time comes, you can easily make your documents ready for the Web via Writer's HTML export feature, or you can automatically publish to a wiki in MediaWiki format. If you need to be sure that what you publish is viewable and looks exactly on every kind of reading ...

1

There are two Sandcastle projects, the original Sandcastle from Microsoft which is no longer under active development, and the... Sandcastle Help File Builder ...which is actively maintained. In this regard, sandcastle is still an option.

1

I good bet for this sort of thing is Jupyter notebooks - in it you can mix documentation, in markdown, formulae, in MathJax, code, in a number of languages, always including Python but a number of other languages are supported depending on which Kernel(s) that you have installed, with syntax highlighting and the results of executing that code including ...

1

Have you tried apidocjs ? Documenting APIs Well, it quite easy, because what we need to do is just commenting on our code. This is an example. /** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {...

1

SchemaCrawler is a free, open-source database discovery tool that you can do what you need. HTML format - SchemaCrawler generates HTML 5 output. ER diagram in output - SchemaCrawler generates ER diagrams embedded in the HTML output, without the need for a separate image file Table and Columns description (packages, procedures etc is a big plus) - ...

1

Try Dataedo - it enables creation of detailed documentation of schema - all tables, columns, views etc. and generation of multiple ERDs and export it to PDF and HTML. Besides that you get ability to group objects into (so called) modules, writing long description using rich text and images, document relations/foreign keys, both, automatically from database ...

1

I am reasonably certain that will a little work you could put something very like what you are describing using Sphinx Docs. The one area that you might have problems with is Real Time Collaborative Editing. Base format is Restructured Text, (rather than markdown), but inputs can be in markdown. Multiple output formats Multiple input sources including ...

1

I would consider looking for a tool that allows you to both document your plans and generate the current code from documentation within the code such as comments, etc., i.e. can both take more or less free form input and can generate information from the code base. Personally I would take a look at Sphinx which has the following features: Free form text in ...

1

MireDot is designed for this. Input: Jax-rs, Spring Web-mvc, Jackson code/configuration files Output: HTML and RAML among other options Requirements 1/2/3 are fulfilled but optional requirements 4/5/6 only partly, in particular the output is read-only. Example HTML output: http://miredot.com/exampledocs/ It is free for open source projects. Note: I ...

1

I would take a very close look at: doxygen It can generate HTML, LaTex, RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages It supports Javadoc style documentation It is a powerful and mature product which is capable of producing good documentation out-of-the-box. However, it does have a learning curve that you will need to ...

1

You need a web browser that also can be used as a what-you-see-is-what-you-get HTML editor. The only one I know and have used is a very old program called Amaya. It lets you browse the HTML files, click on links, and when you see something you want to fix, just start typing and it inserts your text, images, etc. It is free and open source. The interface ...

1

If a programmatic solution is acceptable, Essential PDF and Essential XlsIO can be used to import content from Excel and generate PDF documents. You need to write code (C# or any .NET language) to extract the data from the Excel file (XlsIO is used for this: sample code) and then creating the PDF documents by inserting the content (sample code). The whole ...

1

I'm trying out ngDoc it seems to be better for AngularJS. But I'm keeping this open for further comments and suggestions.

1

Doxygen is a popular, multi-language documentation generator. It is primarily for C++ (probably one of the most complex languages) but includes support for a few others, too. http://www.doxygen.nl/ It may be the most popular such tool outside of JavaDoc/Python docstrings. If you only want syntax highlighting, try pygments.

Only top voted, non community-wiki answers of a minimum length are eligible