Humaid AlQassimi

< Go back

Status update, October 2019

Oct 19, 2019 · 3 min read

A lot has been happening the last month, we have started working on the largest group software development project at the University. We are a team of six people, and have decided to choose Go as our language of choice for the implementation of the smart home system we are building.

We have spend the first couple of weeks setting up the group in GitLab and get continuous integration running (so we can have LaTeX PDF builds, and wiki site deployed automatically). While setting up all the documentation for the team and project, and specifying the software development process of the team, we realised that there is no simple way and neat way to generate a Go project documentation automatically – something like JavaDoc or Doxygen. Using the go doc -all command to generate documentation isn’t great, as it simply dumps the documentation in plain text, with no option to change the format.

Some solutions I have found on the Internet is to run the godoc server (which is what hosts Go’s project homepage), then to use wget to download the HTML pages. The downside of this process is:

  1. Customising the template or layout of the pages is difficult, requiring you to fork the project and change many lines of code.
  2. The project has to be located in the GOPATH, otherwise it will not be detected. Our project is usually hosted outside of the GOPATH, as we are using Go modules.

I tried to find a documentation generator, and sadly Doxygen doesn’t support Go – which may be a good thing (some project members simply didn’t like the style of it). And we cannot use the GoDoc website as the projects are hosted on a private GitLab group.1

After some more searching, I found a project called godoc2md by Dave Cheney, which promised to do exactly what I have wanted to do. After trying to get it compiled and running, I have encountered many compilation errors, mostly due to changes to the GoDoc package which the project depends on. So this seems like a dead end.

I have noticed the output of go doc -all is easily parsable, different lines are formatted differently, which allows me to easily identify which section of the documentation is a function declaration, description, etc. With this I can write a simple program, using some regular expressions to detect different parts and format them correspondingly. And godoc2markdown is born, although it has some quirks which I am ironing out as the project progresses.

I’ll leave you with a picture of a project I have been working on, more details to be released soon.

A picture of a website, called Notes Overflow, with a list of Universitycourses, below it a number of the posts. On the navigation menu there is atitle of the website, and a login link.

That’s all for this month!

  1. As we aren’t allowed to post the project source publicly until the end of the course. ↩︎

Would like to comment on the blog post? Feel free to start a discussion on my public general mailing list.

Articles from blogs I follow around the net

These articles do not represent my opinions or views.

Preparing to Self-Host Email

Preparing to Self-Host Email Written By: Jake Bauer | Posted: 2020-05-15 | Last Updated: 2020-05-15 Email is one of the oldest and most fundamental underpinnings of the Inernet as a whole. Unfortunately, it has a reputation of being very difficult to self-hos…

via - What's New May 15, 2020

Status update, May 2020

Hello, future readers! I am writing to you from one day in the past. I finished my plans for today early and thought I’d get a head start on writing the status updates for tomorrow, or rather, for today. From your reference frame, that is. Let’s start with W…

via Drew DeVault's Blog May 15, 2020

Diving Deeper Into the Small Internet

Diving Deeper Into the Small Internet Written By: Jake Bauer | Posted: 2020-05-13 | Last Updated: 2020-05-13 Yesterday I posted about making my website available over the Gopher protocol. After I posted that, I was alerted to another up-and-coming protocol ca…

via - What's New May 13, 2020

We are complicit in our employer's deeds

Tim Bray’s excellent “Bye Amazon” post inspired me to take this article off of my backlog, where it has been sitting for a few weeks. I applaud Tim for stepping down from a company that has demonstrated itself incompatible with his sense of right and wrong, …

via Drew DeVault's Blog May 5, 2020

Generated by openring