Common usage of Sphinx

Common usage of SphinxUse cases in the business

Sphinx-users.jpGo Yamada

SphinxCon JP 2012

Agenda

1. Self-introduction2. Example1: I want a smart file management.3. Example2: I want to make a Web site easily4. Summary

1. Self-introduction2. Example1: I want a smart file management.3. Example2: I want to make a Web site easily4. Summary

Self-introduction: Go Yamada

Place of workNet Support Co., Ltd.Outsourcing industryI'm infrastructure engineer.

Study sessions I have participatedPythonMercurialVimAgile

OtherProgramming languages ??have been used and are sh,

awk, vbs.I started learning Python a year ago.I like "KAIZEN" and "improvement".

Twitter: usaturn

1. Self-introduction2. Example1: I want a smart file management.3. Example2: I want to make a Web site easily.4. Summary

In the field of infrastructure and file server?

Where even in the field of infrastructure,The contents of the file serverIs pretty much the same.

Example

Create a directory for each department, each team in a large capacity file server, operating without clear rules.

Making too much of a directory, files scattered.

Acquisition of information is inhibited

In a huge file server?

I: Hi, Boss. There are about 6000 files here, Moreover, there are a large number of files of similar content.

How do I do?

Boss: I'm sorry. I do not have time to explain to you. In under this directory, Find files.

Boss: Are working in the same way as everyone. Do something alone.

I: Oh, no.

Managing Files with "directory"

First of all, file names and directory structures are not enough for document management.

File management method was better than I thought

Such as Trac and Redmine Try to use

project management tool!

Managing Files with project management tools

Documentation that came with WikiYou can manage version!I know who also had a history dating

back to edit it, of course!

Managing Files with project management tools

File management with version control systems such as MercurialThat locate the desired file with a description by

making a link to the file in the repository on the Wiki, I can not open the file is available.

However, the projects that I have participated in the past, ated in the

I gave up that introduced a project management tool since it is difficult.

"It is troublesome to learn how to use," says

Sphinx there!

Not be a replacement for the project management tool. However, I can easily put together a document or file.

What I have tried

I have to create a html document using the Sphinx, the projects that I was responsible.

Rather than the Web server, place the html to the file server.

I put a link to a file with a description using the directives ":download:" the binary files Excel, Word, such as PDF.

Evaluation of the document that was created in Sphinx

easy to read!However, the team members did not use the

SphinxI've created a single html "make shinglehtml"

documents that need to be edited by team members. And I must be converted to Word format in MS-Word Plug-in that will help

http://pypi.python.org/pypi/sphinxcontrib-docxbuilder


I introduced the Sphinx in the company that I have served as

I introduced the Sphinx in the e-mail newsletter for employees① The manager of Education was acclaimed

Sphinx.② The manager began to create a Web page for

employees Sphinx immediately.

Sphinx era came to our company! ?

Ride this wave will spread Sphinx in the company! !

Holding of hands-on in-house Sphinx! ! -> However, people in a hundred employees, not only to apply for one.

I did not give up.

We are a business to send a human.Members whose contract expires at the end of

the month, in-house to wait occurs.

Many people waiting house

① They say "Good morning" to come to work at 9:30 in the morning

② Away on a self-learning③ Back to say "goodbye" at 18

Only so much

They are left alone

I suggested

Hack-a-thon by people that are waiting in the company

I suggested that

Demonstration

That we decided

Demonstration

Issues Daily

We are sent by e-mail, to check the daily report of the past is difficult for me

Those who make a daily report does not increase the motivation for you do not know whether you are someone check dailyNot increase motivation if you do not have

someone's response?

There is a need to facilitate access to information

Why did you adopt a Sphinx

Web apps are in daily for good is it?Web app to make a simple but if developers who ...

I have written to the company's SNS to you?The fact that it is easy to return the response is

appropriateHowever, no information is organized in the

framework of the daily reports.

So try to use the Sphinx!Sphinx can easily create a static page is possible.By using the Index directives, it is easy to check daily

you can be.

Devised for the Web site in order to view the daily report

I've created a page that explains how to use Sphinx.

If you place the reStructuredText file to the file server, I have created a mechanism that automatically updates the Web site.

I took advantage of the Index directives(pair).

Result

Or three months have passed since we started it. We are still ongoing.

We have become accustomed to a little reStructuredText.

I have come to discuss daily report of the wait to see a lot of people.

I'm trying to manage the reStructuredText in RhodeCode using Mercurial instead of a file server then.


Summary

Sphinx is not a versatile tool. However, depending on how the effect is produced in excess of their cost ease use from.

Although this is not limited to Sphinx, there is always a backlash when you try to introduce new tools and new ways. We must think of the ideas that somehow overcome the repulsion.

Documents

Common usage of Sphinx