> Separate source and build directories (y/N) : y "source" and "build" directories within the root path. You have two options for placing the build directory for Sphinx output.Įither, you use a directory "_build" within the root path, or you separate Please enter values for the following settings (just press Enter toĪccept a default value, if one is given in brackets). Welcome to the Sphinx quickstart utility. It's pretty safe to accept the defaults, in my opinion. This is a wizard that will walk you through the configuration process for your project. The next step is to configure Sphinx for our project. Just like I take notes to remind myself of stuff at work, I want to do that again for this automated ReST->HTML magic-I want to be able to do this in the future! I figured I would make my notes even more public this time, so you all can enjoy similar bliss. I then wrote a small Web server using Python, so people within the company network could access the latest version of my notes without much hassle. I setup Sphinx to prettify my documentation. However, these individuals probably wouldn't appreciate reading ReST markup as much as I do, so I decided to do something nice for them. Lucky for me, I had taken some nice notes! On several occasions, I had some of the other guys in the company ask me for some clarification on some things I had taken notes on. I've gotten into the habit of taking my notes using reStructured Text, which shouldn't come as any surprise to any of my regular visitors. I often find myself taking notes about various aspects of my job that I feel I would forget as soon as I moved onto another project. And, once again, I'm always on the look-out for other tools to make my work life more interesting and productive! Auto-Generating Documentation Using Mercurial, ReST, and Sphinx Multitail may or may not be a utility you like to use, but it suits my current needs and desires quite well. I simply ssh into my account, run an alias for a ridiculous multitail command, and watch as both log files scroll on by.Īgain, this is just another aspect of my work environment that is fun and useful to me, and I wanted to spread the joy. I've also started using multitail to monitor the access and error logs for my Django sites on WebFaction. I tend to have a 2x2 grid of log files when I use multitail at work. You can also arrange the files/commands you're "tailing" into various rows and columns. Multitail allows you to monitor the output of both tail commands in a single window, reducing clutter on your desktop. Such a command would ssh into two computers, host1 and host2, and run tail -f /path/to/log/file on each. I'm open to other solutions too!Īnyway, I can run a command like the following to monitor multiple remote log files: multitail -l 'ssh "tail -f /path/to/log/file"' -l 'ssh "tail -f /path/to/log/file"' Now, it took me a while to learn how to do this, which is why I'm sharing the information with you.Īnd here comes my usual disclaimer: this may not be the most efficient way to do what I want to do, but it's currently working for me. I want to be able to "tail" a specific log file on each of the virtual machines in one window. Well, my development environment includes at least 5 virtual machines, each of which will be logging different but equally important information. One thing I really, really like about multitail is that I can kinda sorta almost monitor multiple remote files. I've been using multitail for a couple of weeks now (it took me a while to warm up to it after my supervisor introduce it), and I'm quite satisfied with it.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |