Log in or Create a profile

  • Support Home
  • Public Discussions
  • Knowledge Base
  • Go to Rubydoc.info →

Rubydoc.info Support

Home → Knowledge Base → Frequently Asked Questions →

How do I add extra README files to my project?

To add extra documentation files to your project, you need to setup a .yardopts file in the root of your project.

Is this article helpful?

Sending your feedback

Thank you!

Section:
Frequently Asked Questions
Last Updated:
26 Apr, 2011 07:30 AM
  • I get an error message when loading my project, what happened?
  • How do I document my Rails project?
  • How do I add extra README files to my project?
  • Broken links (404) to Markdown or text documents
  • Getting Started with Rubydoc.info

    • Documenting with YARD
    • Setting Up a `.yardopts` File
    • Where is my :nodoc:?
    • Help Improve Rubydoc.info! It's Open Source!
    • View all
  • Github Integration

    • Adding a Project from Github
    • Adding a Rubydoc.info Post-Receive (Commit) Hook on Github
    • View all
  • Frequently Asked Questions

    • I get an error message when loading my project, what happened?
    • How do I document my Rails project?
    • How do I add extra README files to my project?
    • Broken links (404) to Markdown or text documents
    • View all

Recent Discussions

02 Oct, 2022 10:57 PM Page is hung up, on processing an old yanked copy.
31 Jul, 2022 07:44 PM Intellectual property??
23 Jul, 2022 07:31 AM undefined method `new' for nil:NilClass
10 Jun, 2022 01:28 PM Top level namespace empty for latest release
23 Feb, 2022 04:48 PM Unable to leave feedback from rubydoc.info

Recent Articles

Broken links (404) to Markdown or text documents
Adding a Project from Github
Adding a Rubydoc.info Post-Receive (Commit) Hook on Github
How do I document my Rails project?
How do I add extra README files to my project?

Powered by Tender™.