[pgrouting-dev] How do I work on pgRouting documentation?
Worth Lutz
wal3 at mindspring.com
Sun Jul 10 09:54:35 PDT 2016
make doc
That is what I was missing.
Thanks!
Sent from my iPhone
> On Jul 10, 2016, at 12:07 PM, Vicky Vergara <vicky at georepublic.de> wrote:
>
> cd build/
> cmake -DWITH_DOC=ON ..
> make doc
> cd ..
>
> the documentation will be on:
> cd build/doc/html/en/doc/
>
>
>
>> On Sun, Jul 10, 2016 at 9:42 AM, Daniel Kastl <daniel at georepublic.de> wrote:
>> This is my own memo how to build pgRouting with documentation, and how to publish it to GH-Pages and Transifex:
>> https://gist.github.com/dkastl/5617030
>>
>> Vicky did the documentation updates in the past months, so I'm not sure all dependencies and commands are still 100% the same with newer versions of Ubuntu for example.
>> But I just run this part and it worked for me: https://gist.github.com/dkastl/5617030#file-build_pgrouting-sh-L9-L13heers
>> At least "html" worked for me. It seems PDF generation has errors.
>>
>> Cheers,
>> Daniel
>>
>>
>>
>>
>>
>>> On Sun, Jul 10, 2016 at 11:16 PM, Worth Lutz <wal3 at mindspring.com> wrote:
>>> I tried all that and do not see where the updated documentation ends up.
>>>
>>> After doing the build, pointing to:
>>> ~/pgrouting/build/doc/html/index.html
>>> does not seem to work for me. I'm obviously missing something.
>>>
>>> Thanks,
>>>
>>> Worth Lutz
>>>
>>>
>>>> On 7/9/2016 10:06 AM, Daniel Kastl wrote:
>>>> Sorry, should be "cmake" of course.
>>>> ... auto correction...
>>>>
>>>>> On Jul 9, 2016 11:05 PM, "Daniel Kastl" <daniel at georepublic.de> wrote:
>>>>> The documentation is compiled with cake using a special compile flag, see https://github.com/pgrouting/pgrouting/tree/develop#compilation
>>>>>
>>>>> We probably need to make this easier to find in the documentation ;-)
>>>>>
>>>>> Cheers,
>>>>> Daniel
>>>>>
>>>>>> On Jul 9, 2016 9:15 PM, "Worth Lutz" <wal3 at mindspring.com> wrote:
>>>>>> I have been side tracked a bit but have been reading the documentation extensively over the past week. I have had some success working with my data and will be rereading the docs to make sure my understanding is correct. I'll then commit the corrections and additions I'm working on.
>>>>>>
>>>>>> How do I run the docs locally. I am familiar with Sphinx but have not found the place to
>>>>>> make html
>>>>>> I see a make.bat file but that is for Windows. I normally work on Ubuntu and have a Makefile in the directory as well as make.bat. Is development normally done on Windows? And thus the Makefile removed when make.bat was edited?
>>>>>> Thanks for your help.
>>>>>> Worth Lutz
>>>>>>
>>>>>>
>>>>>>> On 7/8/2016 11:18 PM, Vicky Vergara wrote:
>>>>>>> I merged code and more documentation to develop.
>>>>>>> Here is a helpful link for keeping up to date the branches:
>>>>>>> http://docs.pgrouting.org/doxy/2.3-dev-develop/index.html#up_to_date
>>>>>>>
>>>>>>>
>>>>>>>> On Wed, Jun 22, 2016 at 7:57 PM, Vicky Vergara <vicky at georepublic.de> wrote:
>>>>>>>> Thanks
>>>>>>>>
>>>>>>>> On Wed, Jun 22, 2016 at 2:10 PM, Worth Lutz <wal3 at mindspring.com> wrote:
>>>>>>>>> Vicky,
>>>>>>>>>
>>>>>>>>> My github is at:
>>>>>>>>>
>>>>>>>>> https://github.com/worthlutz/pgrouting/
>>>>>>>>>
>>>>>>>>> The branch I'll be using is doc-improvements branched off develop.
>>>>>>>>>
>>>>>>>>> I'll let you know when I push some changes.
>>>>>>>>>
>>>>>>>>> Worth Lutz
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>> On 06/22/2016 02:06 PM, Vicky Vergara wrote:
>>>>>>>>>> Tell when you make the branch
>>>>>>>>>> so I can pinpoint where to find the docuemtnation
>>>>>>>>>>
>>>>>>>>>> On Wed, Jun 22, 2016 at 12:58 PM, Worth Lutz <wal3 at mindspring.com> wrote:
>>>>>>>>>>> Thanks Vicky. I'll let you know what I find.
>>>>>>>>>>>
>>>>>>>>>>> Worth Lutz
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>> On 6/22/2016 1:53 PM, Vicky Vergara wrote:
>>>>>>>>>>>> Hello Worth Lutz.
>>>>>>>>>>>>
>>>>>>>>>>>> The documentation changes you made them to master or to develop?
>>>>>>>>>>>> Right now develop documentation has changed, not in everything put it has lots of changes.
>>>>>>>>>>>> http://docs.pgrouting.org/dev/en/doc/index.html
>>>>>>>>>>>> It is better for us to work on the develop branch which has the 2.3 documentation.
>>>>>>>>>>>> Its changing a lot. so to have the current contents of develop in your for:
>>>>>>>>>>>> git checkout develop
>>>>>>>>>>>> git fetch upstream
>>>>>>>>>>>> git merge upstream/develop
>>>>>>>>>>>> git push
>>>>>>>>>>>> then in the github site you will be able to see that it contains the current contents of develop.
>>>>>>>>>>>> Then you can branch to a working directory
>>>>>>>>>>>> git checkout -b 'improve/documentation'
>>>>>>>>>>>> then do a
>>>>>>>>>>>> git push
>>>>>>>>>>>> and give me the link to the branch in your repository so that if I make changes to develop's documentation, I can make a pull request to your branch with the changes I made.
>>>>>>>>>>>> Work on the documentation, and make pull requests to develop.
>>>>>>>>>>>> thanks.
>>>>>>>>>>>>
>>>>>>>>>>>> Vicky from the pgRouting team
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Wed, Jun 22, 2016 at 12:10 PM, Worth Lutz <wal3 at mindspring.com> wrote:
>>>>>>>>>>>>> If I want to work on some errors/typos in the documentation, how do I do that?
>>>>>>>>>>>>> I've got a fork and want to create a pull request.
>>>>>>>>>>>>> Which branch should I be working on?
>>>>>>>>>>>>> As I'm starting a new routing project, I'm reading (and rereading) the documentation a lot and think I should fix what I find.
>>>>>>>>>>>>>
>>>>>>>>>>>>> --
>>>>>>>>>>>>> Worth Lutz
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> _______________________________________________
>>>>>>>>>>>>> pgrouting-dev mailing list
>>>>>>>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> --
>>>>>>>>>>>> Georepublic UG (haftungsbeschränkt)
>>>>>>>>>>>> Salzmannstraße 44,
>>>>>>>>>>>> 81739 München, Germany
>>>>>>>>>>>>
>>>>>>>>>>>> Vicky Vergara
>>>>>>>>>>>> Operations Research
>>>>>>>>>>>>
>>>>>>>>>>>> eMail: vicky at georepublic.de
>>>>>>>>>>>> Web: https://georepublic.info
>>>>>>>>>>>>
>>>>>>>>>>>> Tel: +49 (089) 4161 7698-1
>>>>>>>>>>>> Fax: +49 (089) 4161 7698-9
>>>>>>>>>>>>
>>>>>>>>>>>> Commercial register: Amtsgericht München, HRB 181428
>>>>>>>>>>>> CEO: Daniel Kastl
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> _______________________________________________
>>>>>>>>>>>> pgrouting-dev mailing list
>>>>>>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> _______________________________________________
>>>>>>>>>>> pgrouting-dev mailing list
>>>>>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>>>>> Georepublic UG (haftungsbeschränkt)
>>>>>>>>>> Salzmannstraße 44,
>>>>>>>>>> 81739 München, Germany
>>>>>>>>>>
>>>>>>>>>> Vicky Vergara
>>>>>>>>>> Operations Research
>>>>>>>>>>
>>>>>>>>>> eMail: vicky at georepublic.de
>>>>>>>>>> Web: https://georepublic.info
>>>>>>>>>>
>>>>>>>>>> Tel: +49 (089) 4161 7698-1
>>>>>>>>>> Fax: +49 (089) 4161 7698-9
>>>>>>>>>>
>>>>>>>>>> Commercial register: Amtsgericht München, HRB 181428
>>>>>>>>>> CEO: Daniel Kastl
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> _______________________________________________
>>>>>>>>>> pgrouting-dev mailing list
>>>>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> _______________________________________________
>>>>>>>>> pgrouting-dev mailing list
>>>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Georepublic UG (haftungsbeschränkt)
>>>>>>>> Salzmannstraße 44,
>>>>>>>> 81739 München, Germany
>>>>>>>>
>>>>>>>> Vicky Vergara
>>>>>>>> Operations Research
>>>>>>>>
>>>>>>>> eMail: vicky at georepublic.de
>>>>>>>> Web: https://georepublic.info
>>>>>>>>
>>>>>>>> Tel: +49 (089) 4161 7698-1
>>>>>>>> Fax: +49 (089) 4161 7698-9
>>>>>>>>
>>>>>>>> Commercial register: Amtsgericht München, HRB 181428
>>>>>>>> CEO: Daniel Kastl
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Georepublic UG (haftungsbeschränkt)
>>>>>>> Salzmannstraße 44,
>>>>>>> 81739 München, Germany
>>>>>>>
>>>>>>> Vicky Vergara
>>>>>>> Operations Research
>>>>>>>
>>>>>>> eMail: vicky at georepublic.de
>>>>>>> Web: https://georepublic.info
>>>>>>>
>>>>>>> Tel: +49 (089) 4161 7698-1
>>>>>>> Fax: +49 (089) 4161 7698-9
>>>>>>>
>>>>>>> Commercial register: Amtsgericht München, HRB 181428
>>>>>>> CEO: Daniel Kastl
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> pgrouting-dev mailing list
>>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>>>
>>>>>>
>>>>>> _______________________________________________
>>>>>> pgrouting-dev mailing list
>>>>>> pgrouting-dev at lists.osgeo.org
>>>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>>
>>>>
>>>> _______________________________________________
>>>> pgrouting-dev mailing list
>>>> pgrouting-dev at lists.osgeo.org
>>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>>
>>>
>>> _______________________________________________
>>> pgrouting-dev mailing list
>>> pgrouting-dev at lists.osgeo.org
>>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>>
>>
>>
>> --
>> Georepublic UG & Georepublic Japan
>> eMail: daniel.kastl at georepublic.de
>> Web: http://georepublic.info
>>
>>
>>
>>
>> _______________________________________________
>> pgrouting-dev mailing list
>> pgrouting-dev at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>
>
>
> --
> Georepublic UG (haftungsbeschränkt)
> Salzmannstraße 44,
> 81739 München, Germany
>
> Vicky Vergara
> Operations Research
>
> eMail: vicky at georepublic.de
> Web: https://georepublic.info
>
> Tel: +49 (089) 4161 7698-1
> Fax: +49 (089) 4161 7698-9
>
> Commercial register: Amtsgericht München, HRB 181428
> CEO: Daniel Kastl
>
> _______________________________________________
> pgrouting-dev mailing list
> pgrouting-dev at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/pgrouting-dev/attachments/20160710/b1b04a00/attachment-0001.html>
More information about the pgrouting-dev
mailing list