https://github.com/robotframework/rfdoc

Automatically exported from code.google.com/p/rfdoc
https://github.com/robotframework/rfdoc

Last synced: 4 months ago
JSON representation

Automatically exported from code.google.com/p/rfdoc

• Host: GitHub
• URL: https://github.com/robotframework/rfdoc
• Owner: robotframework
• License: apache-2.0
• Archived: true
• Created: 2015-08-24T13:02:24.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-02-02T12:59:39.000Z (almost 4 years ago)
• Last Synced: 2024-09-27T10:41:19.070Z (over 1 year ago)
• Language: Python
• Size: 410 KB
• Stars: 15
• Watchers: 8
• Forks: 16
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
RFDoc

=====

Introduction

------------

RFDoc is a web application for storing and searching `Robot Framework

`_ test library and resource file documentations.

RFDoc is implemented using `Django web framework `_.

**Note:** This project is currently not actively maintained.

License

-------

RFDoc is licensed under Apache License 2.0.

See LICENSE.txt for details.

Running RFDoc

-------------

For getting RFDoc to run locally, see

https://github.com/robotframework/rfdoc/blob/wiki/DevelopmentEnvironment.md

For setting up a public production server, see

https://github.com/robotframework/rfdoc/blob/wiki/ProductionEnvironment.md

Directory Layout

----------------

atest/

    Acceptance tests. Naturally using Robot Framework.

src/

    RFDoc source code.

tools/

    Utilities to use as part of the CI pipeline or as SCM hooks.

Running the Acceptance Tests

----------------------------

Acceptance tests are run using ``atest/run_atests.py``.

Run the script without any arguments for help.