add use_mdfile_as_mainpage option

[flixr]

This makes it possible/easier to use a markdown file as mainpage, e.g. the README.md

To use it, add a rosdoc.yaml with

- builder: doxygen
  file_patterns: '*.c *.cpp *.h *.cc *.hh *.dox *.md'
  use_mdfile_as_mainpage: README.md

Description of this option from Doxygen:

If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that is part of the input, its contents will be placed on the main page (index.html). This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the doxygen output.

[jack-oquin]

This looks like a good idea. Thanks for contributing.

Would you be willing to update the rosdoc_lite wiki page to describe the new feature?

[flixr]

Sure.

[flixr]

wiki page updated with an example

[jack-oquin]

Thanks, danke!

[khupilz]

Hi,

I am trying to use this feature but the md file does not show as the main page. Instead in the related pages, a list of md files are shown with their titles, also the README.md. Following is my rosdoc.yaml:

- builder: doxygen
  name: documentation of my_ros_package
  output_dir: my_ros_package
  file_patterns: '*.c *.cpp *.h *.cc *.hh *.dox *.md'
  exclude_patterns: 'test'
  use_mdfile_as_mainpage: README.md

I tried with directly generating the doc using doxygen by having following parameters:

INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md

And it works.

Do we need to add README.md to INPUT?

[flixr]

Are you using the latest version?

khupilz notifications@github.com schrieb am Mo., 7. Mai 2018, 14:18:

Hi,

I am trying to use this feature but the md file does not show as the main page. Instead in the related pages, a list of md files are listed with their titles, also the README.md. Following is my rosdoc.yaml:

• builder: doxygen name: documentation of my_ros_package output_dir: my_ros_package file_patterns: '.c .cpp .h .cc .hh .dox *.md' exclude_patterns: 'test' use_mdfile_as_mainpage: README.md

I tried with directly generating the doc using doxygen hy having following parameters:

INPUT += README.md USE_MDFILE_AS_MAINPAGE = README.md

And it works.

Do we need to add README.md to INPUT?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/ros-infrastructure/rosdoc_lite/pull/80#issuecomment-387061637, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGXQdJ6nSB7GpYItl-4_J0Jr40_dghYks5twEmNgaJpZM4SbbJS .

[khupilz]

I am using ros kinetic under ubuntu 16.04.

I just newly installed rosdoc_lite via apt.

Update:

I cloned the repository and it works.

Thanks for the nice feature.

[AchmadFathoni]

Are you using the latest version? khupilz notifications@github.com schrieb am Mo., 7. Mai 2018, 14:18: … Hi, I am trying to use this feature but the md file does not show as the main page. Instead in the related pages, a list of md files are listed with their titles, also the README.md. Following is my rosdoc.yaml: - builder: doxygen name: documentation of my_ros_package output_dir: my_ros_package file_patterns: '.c .cpp .h .cc .hh .dox *.md' exclude_patterns: 'test' use_mdfile_as_mainpage: README.md I tried with directly generating the doc using doxygen hy having following parameters: INPUT += README.md USE_MDFILE_AS_MAINPAGE = README.md And it works. Do we need to add README.md to INPUT? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#80 (comment)>, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGXQdJ6nSB7GpYItl-4_J0Jr40_dghYks5twEmNgaJpZM4SbbJS .

Hope apt's version of rosdoc_lite will have fix for this bug.