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

19 Jan, 2021 06:19 PM Documentation for gems missing
24 Nov, 2020 03:24 AM docs for gem "launchdarkly-server-sdk" are unavailable
23 Nov, 2020 08:29 AM fxruby gem: Error 503 Service Unavailable
07 Nov, 2020 09:30 PM Missing docs for aerospike gem
20 Sep, 2020 12:17 PM Unable to add github project - 503 service unavailable.

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™.