How to debug sphinx? - debugging

I want to see how sphinx actually works,has anyone tried this?

If you are talking about "Sphinx - the free open-source SQL full-text search engine", then the answer is pretty simple: Go ahead and have a look at the source code :)

Related

How to create a link checker?

I want to understand the logic behind it and how it works as well as which languages I'd need for this matter.
I did a google search and I found out about this open source project on github: https://github.com/stevenvachon/broken-link-checker how could it help?
Thanks in advance.

Automatic english spell-checking in a CI/CD pipeline

I am looking for a tool to spell-check English markdown documents in a pipeline.
Having seen and heard about the Hunspell project, I am not sure if that is the right tool to use - however looking online I might not use the right search terms or my approach is wrong as I do not find many results at all.
Anyone who has any advice of the direction to go?
Many thanks in beforehand.
Answering myself: this is a task for which the codespell CLI tool can be used.

Someone to explain the mechanics for DSL language creation "in plain english"

Basically the problem is that I'm starting doing somme development of Visual Studio 2010 extensions and language definitions are rather complex, so anyone giving a small intro and pointing some good docs would be great
Thanks in advance,
EDIT My basic problem is that I want to define a simple language to create some models on Visual Studio 2k10 and generate some source code using such models. The problem is where can I find some nice books, or do I have to dig into MSDN to unveil the mask... :)
Again, thanks
Have you tried starting with the documentation here? If you found this difficult to start with, how could we make it easier to follow?

Getting started with T4

I want to start writing T4 templates. I've heard a lot of great a things about these templates (in the Hanselminutes podcast mainly) and would like to know more. What are the best locations to look for info on T4 template writing? What do I need to get started implementing my own templates? Are there pitfalls or important things I should know?
I wrote a little post on this with some pointers to other posts:
Tip 3- How to get started with T4 templates
You also might want to check out David Ebbo's blog he has been doing some pretty cool things with T4.
Oleg Sych's blog has a very useful intro.
Hope this helps
Alex
You have to have an editor. Without the syntax highlighting, figuring out which is generated code and which is generator code is an exercise in futility. Here's another editor addin that's free: http://t4-editor.tangible-engineering.com/T4-Editor-Visual-T4-Editing.html
I download this. After I watched this.

.Net XML comment into API Documentation

Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output?
I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this bridge.
Also, I tried setting up sandcastle recently, but it really made my eyes cross. Either I was missing something important in the process or it is just way too involved.
I know somebody out there has a really nice dead-simple solution.
I'm reiterating here because I think my formatting made that paragraph non-inviting to read:
I gave sandcastle a try but had a really hard time getting it set up.
What I really have in mind is something much simpler.
That is, unless I just don't understand the sandcastle process. It seemed like an awful lot of extra baggage to me just to produce something nice for the testers to work with.
You're looking for Sandcastle
Project Page: Sandcastle Releases
Blog: Sandcastle Blog
NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.
Have a look at Sandcastle, which does exactly that. It's also one of the more simpler solutions out there, and it's more or less the tool of choice, so in the long run, maybe we could help you to set up Sandcastle if you specify what issues you encountered during setup?
You should also use the Sandcastle Help File Builder. It provides you with a ndoc like GUI for generating help files so you don't have to do anything from a command prompt.
Welcome to the Sandcastle Help File Builder Project
I've just set up Sandcastle again. Try installing it (the May 2008 release) and search for SandcastleGui.exe or something similar (it's in the examples folder or so).
Click Add Assembly and add your Assembly or Assemblies, add any .xml Documentation files (the ones generated by the compiler if you enabled that option) and then Build.
It will take some time, but the result will be worth the effort. It will actually look up stuff from MSDN, so your resulting documentation will also have the Class Inheritance all the way down to System.Object with links to MSDN and stuff.
Sandcastle seems a bit complicated at first, especially when you want to use it in an automated build, but I am absolutely sure it will be worth the effort.
Also have a look at Sandcastle Help File Builder, this is a somewhat more advanced GUI for it.
Follow this simple 5 step article and you are pretty much done. As a bonus you can use H2Viewer to view Html Help 2.x files.
I use NDoc3

Resources