# rfdoc

**Repository Path**: mirrors_robotframework/rfdoc

## Basic Information

- **Project Name**: rfdoc
- **Description**: Automatically exported from code.google.com/p/rfdoc
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

RFDoc
=====

Introduction
------------

RFDoc is a web application for storing and searching `Robot Framework
<http://robotframework.org>`_ test library and resource file documentations.

RFDoc is implemented using `Django web framework <http://djangoproject.com>`_.

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